com.xceptance.xlt.api.engine.DataManager 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

package com.xceptance.xlt.api.engine;

/**
 * The {@link DataManager} logs data records to a log file, from where they may be read again during test report
 * generation. The {@link DataManager} instance responsible for a certain test user may be obtained from the current
 * session object via {@link Session#getDataManager()}.
 * 
 * @author Jörg Werner (Xceptance Software Technologies GmbH)
 */
public interface DataManager
{
    /**
     * Returns the time that marks the end of the logging period.
     * 
     * @return the end time
     */
    public long getEndOfLoggingPeriod();

    /**
     * Returns the time that marks the beginning of the logging period.
     * 
     * @return the start time
     */
    public long getStartOfLoggingPeriod();

    /**
     * Returns whether or not logging of data records is currently enabled.
     * 
     * @return the logging state
     */
    public boolean isLoggingEnabled();

    /**
     * Logs an event data record that is initialized with the given parameters, but only if logging is enabled and the
     * current time is inside the configured logging period.
     * 
     * @param eventName
     *            the name of the event
     * @param message
     *            the event message
     */
    public void logEvent(String eventName, String message);

    /**
     * Logs the given data record to a log file, but only if logging is enabled and the current time is inside the
     * configured logging period.
     * 
     * @param data
     *            the data record
     */
    public void logDataRecord(Data data);

    /**
     * Sets the time that marks the end of the logging period.
     * 
     * @param time
     *            the end time
     */
    public void setEndOfLoggingPeriod(long time);

    /**
     * Sets whether or not logging of data records is currently enabled.
     * 
     * @param state
     *            the logging state
     */
    public void setLoggingEnabled(boolean state);

    /**
     * Sets the time that marks the beginning of the logging period.
     * 
     * @param time
     *            the start time
     */
    public void setStartOfLoggingPeriod(long time);

}