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   import java.util.Collection;
   22   import java.util.LinkedList;
   23   import java.util.List;
   24   
   25   import org.apache.jmeter.engine.util.CompoundVariable;
   26   import org.apache.jmeter.samplers.SampleResult;
   27   import org.apache.jmeter.samplers.Sampler;
   28   import org.apache.jmeter.threads.JMeterVariables;
   29   import org.apache.jmeter.util.JMeterUtils;
   30   
   31   /**
   32    * Function to get a JMeter property, and optionally store it
   33    *
   34    * Parameters:
   35    *  - property name
   36    *  - variable name (optional)
   37    *  - default value (optional)
   38    *
   39    * Returns:
   40    * - the property value, but if not found:
   41    * - the default value, but if not defined:
   42    * - the property name itself
   43    *
   44    */
   45   public class Property extends AbstractFunction {
   46   
   47       private static final List desc = new LinkedList();
   48   
   49       private static final String KEY = "__property"; //$NON-NLS-1$
   50   
   51       // Number of parameters expected - used to reject invalid calls
   52       private static final int MIN_PARAMETER_COUNT = 1;
   53       private static final int MAX_PARAMETER_COUNT = 3;
   54   
   55       static {
   56           desc.add(JMeterUtils.getResString("property_name_param")); //$NON-NLS-1$
   57           desc.add(JMeterUtils.getResString("function_name_paropt")); //$NON-NLS-1$
   58           desc.add(JMeterUtils.getResString("property_default_param")); //$NON-NLS-1$
   59       }
   60   
   61       private Object[] values;
   62   
   63       public Property() {
   64       }
   65   
   66       public synchronized String execute(SampleResult previousResult, Sampler currentSampler)
   67               throws InvalidVariableException {
   68           String propertyName = ((CompoundVariable) values[0]).execute();
   69           String propertyDefault = propertyName;
   70           if (values.length > 2) { // We have a 3rd parameter
   71               propertyDefault = ((CompoundVariable) values[2]).execute();
   72           }
   73           String propertyValue = JMeterUtils.getPropDefault(propertyName, propertyDefault);
   74           if (values.length > 1) {
   75               String variableName = ((CompoundVariable) values[1]).execute();
   76               if (variableName.length() > 0) {// Allow for empty name
   77                   final JMeterVariables variables = getVariables();
   78                   if (variables != null) {
   79                       variables.put(variableName, propertyValue);
   80                   }
   81               }
   82           }
   83           return propertyValue;
   84   
   85       }
   86   
   87       public synchronized void setParameters(Collection parameters) throws InvalidVariableException {
   88           checkParameterCount(parameters, MIN_PARAMETER_COUNT, MAX_PARAMETER_COUNT);
   89           values = parameters.toArray();
   90       }
   91   
   92       public String getReferenceKey() {
   93           return KEY;
   94       }
   95   
   96       public List getArgumentDesc() {
   97           return desc;
   98       }
   99   
  100   }

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