com.xceptance.xlt.agent.ExecutionTimerFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xlt Show documentation
XLT (Xceptance LoadTest) is an extensive load and performance test tool developed and maintained by Xceptance.
There is a newer version: 8.1.0
/*
 * Copyright (c) 2005-2022 Xceptance Software Technologies GmbH
 *
 * Licensed 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 com.xceptance.xlt.agent;

import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import com.xceptance.xlt.agentcontroller.TestUserConfiguration;

/**
 * The ExecutionTimerFactory creates different ExecutionTimer instances depending on the creation parameters. Note that
 * only one execution timer instance is created for one type of test case and this instance is shared between all load
 * test threads running this type of test.
 * 
 * @see PeriodicExecutionTimer
 * @see RandomExecutionTimer
 * @author Jörg Werner (Xceptance Software Technologies GmbH)
 */
public abstract class ExecutionTimerFactory
{
    /**
     * Maps a test case case name to its corresponding execution timer.
     */
    private static final Map timers = new HashMap();

    /**
     * Returns all the executions timers that have been created so far.
     * 
     * @return the execution timers
     */
    public static Collection getTimers()
    {
        return Collections.unmodifiableCollection(timers.values());
    }

    /**
     * Returns the one execution timer responsible for the given test case class. Depending on the specified
     * configuration parameters, a different class will be instantiated.
     * 
     * @param config
     *            the user configuration
     * @return the execution timer
     */
    public static synchronized AbstractExecutionTimer createTimer(final TestUserConfiguration config)
    {
        final String userTypeName = config.getUserName();
        AbstractExecutionTimer executionTimer = timers.get(userTypeName);

        // check whether we already have one
        if (executionTimer == null)
        {
            // no -> create one
            final int[][] arrivalRates = config.getArrivalRates();
            final int[][] users = config.getUsers();
            final int shutdownPeriod = config.getShutdownPeriod();
            final int agentIndex = config.getAgentIndex();

            final int warmUpPeriod = config.getWarmUpPeriod();
            final int measurementPeriod = config.getMeasurementPeriod();
            final int initialDelay = config.getInitialDelay();
            final int duration = warmUpPeriod + measurementPeriod;

            if (arrivalRates == null)
            {
                executionTimer = new RandomExecutionTimer(userTypeName, initialDelay, duration, shutdownPeriod, users, agentIndex);
            }
            else
            {
                executionTimer = new PeriodicExecutionTimer(userTypeName, initialDelay, duration, shutdownPeriod, arrivalRates, agentIndex,
                                                            config.getWeightFunction());
            }

            timers.put(userTypeName, executionTimer);
        }

        return executionTimer;
    }
}