/*
* 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.modifiers;
import java.io.ObjectStreamException;
import java.io.Serializable;
import java.text.DecimalFormat;
import org.apache.jmeter.engine.event.LoopIterationEvent;
import org.apache.jmeter.engine.event.LoopIterationListener;
import org.apache.jmeter.engine.util.NoThreadClone;
import org.apache.jmeter.testelement.AbstractTestElement;
import org.apache.jmeter.testelement.property.BooleanProperty;
import org.apache.jmeter.testelement.property.LongProperty;
import org.apache.jmeter.threads.JMeterContextService;
import org.apache.jmeter.threads.JMeterVariables;
/**
* Provides a counter per-thread/user or globally
* The long value can be
*/
public class CounterConfig extends AbstractTestElement implements Serializable, LoopIterationListener, NoThreadClone {
private final static String START = "CounterConfig.start"; // $NON-NLS-1$
private final static String END = "CounterConfig.end"; // $NON-NLS-1$
private final static String INCREMENT = "CounterConfig.incr"; // $NON-NLS-1$
private final static String FORMAT = "CounterConfig.format"; // $NON-NLS-1$
public final static String PER_USER = "CounterConfig.per_user"; // $NON-NLS-1$
public final static String VAR_NAME = "CounterConfig.name"; // $NON-NLS-1$
// This class is not cloned per thread, so this is shared
private long globalCounter = Long.MIN_VALUE;
// Used for per-thread/user numbers
private transient ThreadLocal perTheadNumber;
private void init() {
perTheadNumber = new ThreadLocal() {
protected synchronized Object initialValue() {
return new Long(getStart());
}
};
}
public CounterConfig() {
super();
init();
}
private Object readResolve() throws ObjectStreamException{
init();
return this;
}
/**
* @see LoopIterationListener#iterationStart(LoopIterationEvent)
*/
public synchronized void iterationStart(LoopIterationEvent event) {
// Cannot use getThreadContext() as not cloned per thread
JMeterVariables variables = JMeterContextService.getContext().getVariables();
long start = getStart(), end = getEnd(), increment = getIncrement();
if (!isPerUser()) {
if (globalCounter == Long.MIN_VALUE || globalCounter > end) {
globalCounter = start;
}
variables.put(getVarName(), formatNumber(globalCounter));
globalCounter += increment;
} else {
long current = ((Long) perTheadNumber.get()).longValue();
variables.put(getVarName(), formatNumber(current));
current += increment;
if (current > end) {
current = start;
}
perTheadNumber.set(new Long(current));
}
}
// Use format to create number; if it fails, use the default
private String formatNumber(long value){
String format = getFormat();
if (format != null && format.length() > 0) {
try {
DecimalFormat myFormatter = new DecimalFormat(format);
return myFormatter.format(value);
} catch (NumberFormatException ignored) {
} catch (IllegalArgumentException ignored) {
}
}
return Long.toString(value);
}
public void setStart(long start) {
setProperty(new LongProperty(START, start));
}
public void setStart(String start) {
setProperty(START, start);
}
public long getStart() {
return getPropertyAsLong(START);
}
public String getStartAsString() {
return getPropertyAsString(START);
}
public void setEnd(long end) {
setProperty(new LongProperty(END, end));
}
public void setEnd(String end) {
setProperty(END, end);
}
/**
*
* @return counter upper limit (default Long.MAX_VALUE)
*/
public long getEnd() {
long propertyAsLong = getPropertyAsLong(END);
if (propertyAsLong == 0 && "".equals(getProperty(END).getStringValue())) {
propertyAsLong = Long.MAX_VALUE;
}
return propertyAsLong;
}
public String getEndAsString(){
return getPropertyAsString(END);
}
public void setIncrement(long inc) {
setProperty(new LongProperty(INCREMENT, inc));
}
public void setIncrement(String incr) {
setProperty(INCREMENT, incr);
}
public long getIncrement() {
return getPropertyAsLong(INCREMENT);
}
public String getIncrementAsString() {
return getPropertyAsString(INCREMENT);
}
public void setIsPerUser(boolean isPer) {
setProperty(new BooleanProperty(PER_USER, isPer));
}
public boolean isPerUser() {
return getPropertyAsBoolean(PER_USER);
}
public void setVarName(String name) {
setProperty(VAR_NAME, name);
}
public String getVarName() {
return getPropertyAsString(VAR_NAME);
}
public void setFormat(String format) {
setProperty(FORMAT, format);
}
public String getFormat() {
return getPropertyAsString(FORMAT);
}
}