com.xceptance.xlt.mastercontroller.MasterControllerUI 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.mastercontroller;

import com.xceptance.xlt.util.FailedAgentControllerCollection;

/**
 * The MasterControllerUI is the API the master controller uses to communicate progress and error information to the
 * user interface.
 */
public interface MasterControllerUI
{
    /**
     * Called after uploading agent files to the given agent controller.
     */
    public void agentFilesUploaded();

    /**
     * Called after starting the agent at the given agent controller.
     */
    public void agentsStarted();

    /**
     * Called after requesting the agent status from the given agent controller. If the operation was successful, the
     * passed results collection is empty. Otherwise, it contains information about which agent controller has failed as
     * well as why it has failed.
     * 
     * @param results
     *            the failed agent controllers
     */
    public void agentStatusReceived(FailedAgentControllerCollection results);

    /**
     * Called after stopping the agent at the given agent controller.
     */
    public void agentsStopped();

    /**
     * Called before downloading test results from the given agent controller.
     * 
     * @param agentController
     *            the respective agent controller
     */
    public void downloadingTestResults();

    /**
     * Called before requesting the agent status from the given agent controller.
     * 
     * @param agentController
     *            the respective agent controller
     */
    public void receivingAgentStatus();

    /**
     * Called before starting the agents.
     */
    public void startingAgents();

    /**
     * Called before stopping the agent at the given agent controller.
     * 
     * @param agentController
     *            the respective agent controller
     */
    public void stoppingAgents();

    /**
     * Called after downloading test results from the given agent controller. If the operation was successful, the
     * passed results collection is empty. Otherwise, it contains information about which agent controller has failed as
     * well as why it has failed.
     * 
     * @param results
     *            the failed agent controllers
     */
    public void testResultsDownloaded(FailedAgentControllerCollection results);

    /**
     * Called before uploading agent files.
     */
    public void uploadingAgentFiles();

    /**
     * Called if the master can not connect to a agent controller. Introduces skipped agent controllers.
     * 
     * @param unconnectedAgentControllers
     *            the agent controllers that could not be connected to
     */
    public void skipAgentControllerConnections(FailedAgentControllerCollection unconnectedAgentControllers);

    /**
     * Returns the number of seconds to wait before the status list is updated again.
     * 
     * @return the update interval
     */
    public int getStatusListUpdateInterval();
}