com.ibm.rational.test.lt.recorder.core.clients

Class AbstractExecutableClientDelegate

    • Field Detail

      • PROGRAM_PATH_PROPERTY

        public static final String PROGRAM_PATH_PROPERTY
        This runtime property defines the path of the executable to execute. Value type: java.io.File. This property can also be used in the client configuration of com.ibm.rational.test.lt.recorder.core.application. In this case, its value type is java.lang.String and it must represent an absolute path to the executable.
      • ARGUMENTS_PROPERTY

        public static final String ARGUMENTS_PROPERTY
        This runtime property defines the arguments to be passed to the executable. Value type: java.util.List. This property can also be used in the client configuration of com.ibm.rational.test.lt.recorder.core.application. In this case, its value type is java.lang.String and it must contain the arguments separated by a white space.
      • WORKKING_DIRECTORY_PROPERTY

        public static final String WORKKING_DIRECTORY_PROPERTY
        This runtime property defines the working directory where the executable should be started. Value type: java.io.File. The property value may be null, meaning that the current directory of the lauching process is to be used. This property can also be used in the client configuration of com.ibm.rational.test.lt.recorder.core.application. In this case, its value type is java.lang.String and it must represent an absolute path the directory. Default value is null.
      • ENVIRONMENT_PROPERTY

        public static final String ENVIRONMENT_PROPERTY
        This runtime property defines the initial variables environment of the program to execute. Value type: java.util.Map. This property can also be used in the client configuration of com.ibm.rational.test.lt.recorder.core.executableClient. In this case, its value type is java.lang.String and it must represent the set of variable environments, in the form of a semi-colon-separated list of pairs name=value (e.g. "variable1=value1;variable2=value2").
      • CONSOLE_OUT_PROPERTY

        public static final String CONSOLE_OUT_PROPERTY
        This runtime property defines whether the standard output stream of the process should be visible to the user. Otherwise, any content directed to the standard output by the executable will be discarded. Value type: java.lang.Boolean. This property can also be used in the client configuration of com.ibm.rational.test.lt.recorder.core.application. In this case, its value type is boolean.
      • CONSOLE_ERR_PROPERTY

        public static final String CONSOLE_ERR_PROPERTY
        This runtime property defines whether the error output stream of the process should be visible to the user. Otherwise, any content directed to the error output by the executable will be discarded. Value type: java.lang.Boolean. This property can also be used in the client configuration of com.ibm.rational.test.lt.recorder.core.application. In this case, its value type is boolean.
      • CONSOLE_IN_PROPERTY

        public static final String CONSOLE_IN_PROPERTY
        This runtime property defines whether the input console of the process should be available to the user. Otherwise, no input may be sent to the input stream of the executable. Value type: java.lang.Boolean. This property can also be used in the client configuration of com.ibm.rational.test.lt.recorder.core.application. In this case, its value type is boolean.
      • WAIT_FOR_PROCESS_TREE_TERMINATION_PROPERTY

        public static final String WAIT_FOR_PROCESS_TREE_TERMINATION_PROPERTY
        This runtime property defines whether the client should wait only for the process it has launched to exit before reporting termination (value: false), or if it should wait for the whole process tree (i.e. the launched process, and any child process directly or indirectly launched by it or by a child) (value: true). Value type: java.lang.Boolean. Default value: true. This property can also be used in the client configuration of com.ibm.rational.test.lt.recorder.core.application. In this case, its value type is boolean.
    • Constructor Detail

      • AbstractExecutableClientDelegate

        public AbstractExecutableClientDelegate()
    • Method Detail

      • setWorkingDirectory

        protected abstract void setWorkingDirectory(File dir)
      • setProgramPath

        protected abstract void setProgramPath(File path)
      • setArguments

        protected abstract void setArguments(List<String> args)
      • setEnvironment

        protected abstract void setEnvironment(Map<String,String> environment)
      • setShowOutConsole

        protected abstract void setShowOutConsole(boolean show)
      • setShowErrConsole

        protected abstract void setShowErrConsole(boolean show)
      • setShowInConsole

        protected abstract void setShowInConsole(boolean show)
      • setWaitForProcessTreeTermination

        protected abstract void setWaitForProcessTreeTermination(boolean wait)
      • getArguments

        protected abstract List<String> getArguments()
      • getProgramPath

        protected abstract File getProgramPath()
      • getWorkingDirectory

        protected abstract File getWorkingDirectory()
      • isShowOutConsole

        protected abstract boolean isShowOutConsole()
      • isShowErrConsole

        protected abstract boolean isShowErrConsole()
      • isShowInConsole

        protected abstract boolean isShowInConsole()
      • isWaitForProcessTreeTermination

        protected abstract boolean isWaitForProcessTreeTermination()
      • getProperty

        public Object getProperty(String name)
                           throws UnsupportedPropertyException
        Description copied from interface: IRecordingComponentDelegate
        Gets a runtime property of the delegate. The meaning of the property and its value is specific to the delegate and part of the interface between the delegate and other recording components. In particular, the time when the value can be read is let to the delegate implementation (for instance, a property may be read only after the component has started).
        Specified by:
        getProperty in interface IRecordingComponentDelegate
        Overrides:
        getProperty in class BaseClientDelegate
        Parameters:
        name - The property name
        Returns:
        The property value
        Throws:
        UnsupportedPropertyException - If the delegate does not support the property (either because it does not define such a property, or because the property is read at an inappropriate time).
      • setProperty

        public void setProperty(String name,
                       Object value)
                         throws UnsupportedPropertyException
        Description copied from interface: IRecordingComponentDelegate
        Sets the value of a runtime property of the delegate. The meaning of the property and its value is specific to the delegate and part of the interface between the delegate and other recording components. In particular, the time when the value can be set is defined by the delegate implementation (for instance, a property may be set only before the component is started).
        Specified by:
        setProperty in interface IRecordingComponentDelegate
        Overrides:
        setProperty in class BaseClientDelegate
        Parameters:
        name - The property name
        Throws:
        UnsupportedPropertyException - If the delegate does not support the property (either because it does not define such a property, or because the property is set at an inappropriate time).
IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2013. All rights reserved.