Save This Page
Home » jakarta-jmeter-2.3.4_src » org.apache.jmeter.functions » [javadoc | source]
    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *   http://www.apache.org/licenses/LICENSE-2.0
   10    *
   11    * Unless required by applicable law or agreed to in writing, software
   12    * distributed under the License is distributed on an "AS IS" BASIS,
   13    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   14    * See the License for the specific language governing permissions and
   15    * limitations under the License.
   16    *
   17    */
   18   
   19   package org.apache.jmeter.functions;
   20   
   21   
   22   import java.util.Collection;
   23   import java.util.LinkedList;
   24   import java.util.List;
   25   
   26   import org.apache.jmeter.engine.util.CompoundVariable;
   27   import org.apache.jmeter.samplers.SampleResult;
   28   import org.apache.jmeter.samplers.Sampler;
   29   import org.apache.jmeter.util.JMeterUtils;
   30   
   31   /**
   32    * Function to set a JMeter property
   33    *
   34    * Parameters: - property name - value
   35    *
   36    * Usage:
   37    *
   38    * Set the property value in the appropriate GUI by using the string:
   39    * ${__setProperty(propname,propvalue[,returnvalue?])}
   40    *
   41    * Returns: nothing or original value if the 3rd parameter is true
   42    *
   43    */
   44   public class SetProperty extends AbstractFunction {
   45   
   46       private static final List desc = new LinkedList();
   47   
   48       private static final String KEY = "__setProperty"; //$NON-NLS-1$
   49   
   50       // Number of parameters expected - used to reject invalid calls
   51       private static final int MIN_PARAMETER_COUNT = 2;
   52   
   53       private static final int MAX_PARAMETER_COUNT = 3;
   54       static {
   55           desc.add(JMeterUtils.getResString("property_name_param")); //$NON-NLS-1$
   56           desc.add(JMeterUtils.getResString("property_value_param")); //$NON-NLS-1$
   57           desc.add(JMeterUtils.getResString("property_returnvalue_param")); //$NON-NLS-1$
   58       }
   59   
   60       private Object[] values;
   61   
   62       public SetProperty() {
   63       }
   64   
   65       public synchronized String execute(SampleResult previousResult, Sampler currentSampler)
   66               throws InvalidVariableException {
   67           String propertyName = ((CompoundVariable) values[0]).execute();
   68   
   69           String propertyValue = ((CompoundVariable) values[1]).execute();
   70   
   71           boolean returnValue = false;// should we return original value?
   72           if (values.length > 2) {
   73               returnValue = ((CompoundVariable) values[2]).execute().equalsIgnoreCase("true"); //$NON-NLS-1$
   74           }
   75   
   76           if (returnValue) { // Only obtain and cast the return if needed
   77               return (String) JMeterUtils.setProperty(propertyName, propertyValue);
   78           } else {
   79               JMeterUtils.setProperty(propertyName, propertyValue);
   80               return "";
   81           }
   82       }
   83   
   84       public synchronized void setParameters(Collection parameters) throws InvalidVariableException {
   85           checkParameterCount(parameters, MIN_PARAMETER_COUNT, MAX_PARAMETER_COUNT);
   86           values = parameters.toArray();
   87       }
   88   
   89       public String getReferenceKey() {
   90           return KEY;
   91       }
   92   
   93       public List getArgumentDesc() {
   94           return desc;
   95       }
   96   
   97   }

Save This Page
Home » jakarta-jmeter-2.3.4_src » org.apache.jmeter.functions » [javadoc | source]