alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

JMeter example source code file (SetProperty.java)

This example JMeter source code file (SetProperty.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - JMeter tags/keywords

compoundvariable, compoundvariable, invalidvariableexception, key, list, max_parameter_count, min_parameter_count, non-nls-1, non-nls-1, override, override, setproperty, string, string, util

The JMeter SetProperty.java source code

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package org.apache.jmeter.functions;


import java.util.Collection;
import java.util.LinkedList;
import java.util.List;

import org.apache.jmeter.engine.util.CompoundVariable;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.samplers.Sampler;
import org.apache.jmeter.util.JMeterUtils;

/**
 * Function to set a JMeter property
 *
 * Parameters: - property name - value
 *
 * Usage:
 *
 * Set the property value in the appropriate GUI by using the string:
 * ${__setProperty(propname,propvalue[,returnvalue?])}
 *
 * Returns: nothing or original value if the 3rd parameter is true
 *
 */
public class SetProperty extends AbstractFunction {

    private static final List<String> desc = new LinkedList();

    private static final String KEY = "__setProperty"; //$NON-NLS-1$

    // Number of parameters expected - used to reject invalid calls
    private static final int MIN_PARAMETER_COUNT = 2;

    private static final int MAX_PARAMETER_COUNT = 3;
    static {
        desc.add(JMeterUtils.getResString("property_name_param")); //$NON-NLS-1$
        desc.add(JMeterUtils.getResString("property_value_param")); //$NON-NLS-1$
        desc.add(JMeterUtils.getResString("property_returnvalue_param")); //$NON-NLS-1$
    }

    private Object[] values;

    public SetProperty() {
    }

    /** {@inheritDoc} */
    @Override
    public synchronized String execute(SampleResult previousResult, Sampler currentSampler)
            throws InvalidVariableException {
        String propertyName = ((CompoundVariable) values[0]).execute();

        String propertyValue = ((CompoundVariable) values[1]).execute();

        boolean returnValue = false;// should we return original value?
        if (values.length > 2) {
            returnValue = ((CompoundVariable) values[2]).execute().equalsIgnoreCase("true"); //$NON-NLS-1$
        }

        if (returnValue) { // Only obtain and cast the return if needed
            return (String) JMeterUtils.setProperty(propertyName, propertyValue);
        } else {
            JMeterUtils.setProperty(propertyName, propertyValue);
            return "";
        }
    }

    /** {@inheritDoc} */
    @Override
    public synchronized void setParameters(Collection<CompoundVariable> parameters) throws InvalidVariableException {
        checkParameterCount(parameters, MIN_PARAMETER_COUNT, MAX_PARAMETER_COUNT);
        values = parameters.toArray();
    }

    /** {@inheritDoc} */
    @Override
    public String getReferenceKey() {
        return KEY;
    }

    /** {@inheritDoc} */
    public List<String> getArgumentDesc() {
        return desc;
    }

}

Other JMeter examples (source code examples)

Here is a short list of links related to this JMeter SetProperty.java source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.