JMeter example source code file (UserSequence.java)

This example JMeter source code file (UserSequence.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

hashmap, io, iterator, list, logger, map, map, serializable, serializable, string, string, usersequence, usersequence, util

The JMeter UserSequence.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.protocol.http.modifier;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.apache.jorphan.logging.LoggingManager;
import org.apache.log.Logger;

/**
 * This module controls the Sequence in which user details are returned. This
 * module uses round robin allocation of users.
 *
 * @version $Revision: 810036 $
 */
public class UserSequence implements Serializable {
    private static final long serialVersionUID = 233L;

    private static final Logger log = LoggingManager.getLoggerForClass();

    // -------------------------------------------
    // Constants and Data Members
    // -------------------------------------------
    private List<Map allUsers;

    private transient Iterator<Map indexOfUsers;

    // -------------------------------------------
    // Constructors
    // -------------------------------------------

    public UserSequence() {
    }

    /**
     * Load all user and parameter data into the sequence module.
     * <P>
     * ie a Set of Mapped "parameter names and parameter values" for each user
     * to be loaded into the sequencer.
     */
    public UserSequence(List<Map allUsers) {
        this.allUsers = allUsers;

        // initalise pointer to first user
        indexOfUsers = allUsers.iterator();
    }

    // -------------------------------------------
    // Methods
    // -------------------------------------------

    /**
     * Returns the parameter data for the next user in the sequence
     *
     * @return a Map object of parameter names and matching parameter values for
     *         the next user
     */
    public synchronized Map<String, String> getNextUserMods() {
        // Use round robin allocation of user details
        if (!indexOfUsers.hasNext()) {
            indexOfUsers = allUsers.iterator();
        }

        Map<String, String> user;
        if (indexOfUsers.hasNext()) {
            user = indexOfUsers.next();
            log.debug("UserSequence.getNextuserMods(): current parameters will be " + "changed to: " + user);
        } else {
            // no entries in all users, therefore create an empty Map object
            user = new HashMap<String, String>();
        }

        return user;
    }
}