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

Class BaseRecorderDelegate

  • java.lang.Object
    • com.ibm.rational.test.lt.recorder.core.extensibility.BaseRecorderDelegate
    • Constructor Detail

      • BaseRecorderDelegate

        public BaseRecorderDelegate()
    • Method Detail

      • getContext

        public IRecorderContext getContext()
        Returns the recorder context. This can be used to issue log traces, send messages to the user, and send packets captured by the recorder.
        Returns:
        A recorder context.
      • sendStarted

        protected final void sendStarted(boolean recordingEnabled)
        Parameters:
        recordingEnabled - Whether the recorder is recording or ignoring captured information.
        See Also:
        IRecorderDelegate.start(boolean)
      • sendUserMessage

        public void sendUserMessage(String msg)
      • messageReceived

        public void messageReceived(Message message)
        Description copied from interface: IRecordingComponentDelegate
        This method is invoked by the context when a message is sent to this delegate. If the delegate doesn't know how to understand or handle the message, it should silently ignore it.
        Specified by:
        messageReceived in interface IRecordingComponentDelegate
        Parameters:
        message - A message.
      • 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
        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
        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).
      • savePreference

        public final void savePreference(String bundleId,
                          String preferenceName,
                          Object preferenceValue)
        Let the framework save the specified preference. If the delegate runs locally in the workbench, it is not required to go through this method for saving a preference, however this method may be useful for delegates running outside the workbench and that need to alter the preferences in the workbench.
        Parameters:
        bundleId - The bundle (or plug-in) id where the specified preference must be saved.
        preferenceName - The preference name
        preferenceValue - The preference value. Must be one the following types: Boolean, byte[], Double, Float, Integer, Long or String. Other types are not supported and will be ignored.
IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2013. All rights reserved.