com.ibm.rational.test.lt.datacorrelation.execution.sub

Interface IDataSub

  • All Superinterfaces:
    com.ibm.rational.test.lt.kernel.dc.IKDataSub


    public interface IDataSub
    extends com.ibm.rational.test.lt.kernel.dc.IKDataSub
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void addSubInstruction(com.ibm.rational.test.lt.datacorrelation.execution.sub.ISubRule sub) 
      void addSubInstruction(String propertyName, boolean encode, com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar)
      This function will add a substitute instruction for where to substitute data in the given propertyName.
      void addSubInstruction(String propertyName, int offset, int length, boolean encode, com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar)
      This function will add a substitute instruction for where to substitute data in the given propertyName
      void addSubInstruction(String propertyName, int offset, int length, boolean encode, com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar, boolean init, String name, RPTEvent behavior)
      This function will add a substitute instruction for where to substitute data in the given propertyName
      void addSubInstruction(String propertyName, int offset, int length, com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar)
      This function will add a substitute instruction for where to substitute data in the given propertyName, encoding is assumed false
      long calculateSubstituteDataLength(Object logAction, Object theSubstObj, String charset)
      This function will return the length of the chunk (HTTPPostDataChunk) as it would be IF substitution had occurred WITHOUT actually doing the substitution.
      ArrayList<com.ibm.rational.test.lt.datacorrelation.execution.sub.FileSubRule> getFileSubRules()
      Deprecated.  
      long getMaxSubLengthNeeded() 
      ArrayList getRulesOfType(String ruleType) 
      void substituteData(Object action, HashMap hm)
      This function will actually do the substitution of the data executing all the substitution instructions that were stored as part of the addSubInstruction
      void substituteData(Object logAction, Object theSubstObj, String id, HashMap hm)
      This function will actually do the substitution of the data executing all the substitution instructions that were stored as part of the addSubInstruction
      • Methods inherited from interface com.ibm.rational.test.lt.kernel.dc.IKDataSub

        getEvents, substituteData
    • Method Detail

      • addSubInstruction

        void addSubInstruction(String propertyName,
                             int offset,
                             int length,
                             com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar)
        This function will add a substitute instruction for where to substitute data in the given propertyName, encoding is assumed false
        Parameters:
        propertyName - - where in the Action to do the substitution
        offset - - offset into the string to start the substitution
        length - - the length of the string that is to be substituted
        dcVar - - the datacorrelation variable to use for the substitution
      • addSubInstruction

        void addSubInstruction(String propertyName,
                             int offset,
                             int length,
                             boolean encode,
                             com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar)
        This function will add a substitute instruction for where to substitute data in the given propertyName
        Parameters:
        propertyName - - where in the Action to do the substitution
        offset - - offset into the string to start the substitution
        length - - the length of the string that is to be substituted
        encode - - whether or not to encode the data being substituted
        dcVar - - the datacorrelation variable to use for the substitution
      • addSubInstruction

        void addSubInstruction(String propertyName,
                             boolean encode,
                             com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar)
        This function will add a substitute instruction for where to substitute data in the given propertyName. This will substitute for the entire string.
        Parameters:
        propertyName - - where in the Action to do the substitution
        encode - - whether or not to encode the data being substituted
        dcVar - - the datacorrelation variable to use for the substitution
      • addSubInstruction

        void addSubInstruction(com.ibm.rational.test.lt.datacorrelation.execution.sub.ISubRule sub)
        Parameters:
        sub - - this is a substitution Rule that has already been created. It will be executed in conjunction with this substituter
      • substituteData

        void substituteData(Object action,
                          HashMap hm)
        This function will actually do the substitution of the data executing all the substitution instructions that were stored as part of the addSubInstruction
        Parameters:
        action - - the action to pull properties out of and substitute on
        hm - - the hash map to put what the new property should look like
      • substituteData

        void substituteData(Object logAction,
                          Object theSubstObj,
                          String id,
                          HashMap hm)
        This function will actually do the substitution of the data executing all the substitution instructions that were stored as part of the addSubInstruction
        Parameters:
        logAction - - the action used for logging
        theSubstObj - - the object to pull properties out of and substitute on
        id - - guid of substituted object
        hm - - the hash map to put what the new property should look like
      • addSubInstruction

        void addSubInstruction(String propertyName,
                             int offset,
                             int length,
                             boolean encode,
                             com.ibm.rational.test.lt.datacorrelation.execution.harvest.IDataCorrelationVar dcVar,
                             boolean init,
                             String name,
                             RPTEvent behavior)
        This function will add a substitute instruction for where to substitute data in the given propertyName
        Parameters:
        propertyName - - where in the Action to do the substitution
        offset - - offset into the string to start the substitution
        length - - the length of the string that is to be substituted
        encode - - whether or not to encode the data being substituted
        dcVar - - the datacorrelation variable to use for the substitution
        init - - tells whether SubRule should initialize the dcVar before executing
        behavior - - if the substitution should fail, what action should be taken?
      • calculateSubstituteDataLength

        long calculateSubstituteDataLength(Object logAction,
                                         Object theSubstObj,
                                         String charset)
        This function will return the length of the chunk (HTTPPostDataChunk) as it would be IF substitution had occurred WITHOUT actually doing the substitution. This is needed to compute the new "Content-Length: " for large POST requests which are not chunked.
        Parameters:
        logAction - - the action used for logging
        theSubstObj - - the object to pull properties out of and substitute on
        Returns:
        - the total length of the chunk after substitution occurs.
      • getFileSubRules

        ArrayList<com.ibm.rational.test.lt.datacorrelation.execution.sub.FileSubRule> getFileSubRules()
        Deprecated. 
        Returns:
        - a list of type @link{FileSubRule}
      • getRulesOfType

        ArrayList getRulesOfType(String ruleType)
        Parameters:
        ruleType - - Object.getClass().getName(); - the type of rules you want in a list
        Returns:
        - the rules asked for. Will be empty list if no rules of that type existed
      • getMaxSubLengthNeeded

        long getMaxSubLengthNeeded()
        Returns:
        - the maximum amount of data that needs to be loaded for substitution to occur successfully.
IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2013. All rights reserved.