io.qameta.allure.core.Plugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of allure-plugin-api Show documentation

Module allure-plugin-api of Allure Framework.

There is a newer version: 2.33.0

/*
 *  Copyright 2016-2023 Qameta Software OÜ
 *
 *  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 io.qameta.allure.core;

import io.qameta.allure.Extension;
import io.qameta.allure.PluginConfiguration;

import java.io.IOException;
import java.nio.file.Path;
import java.util.List;
import java.util.Map;

/**
 * Base plugin interface.
 *
 * @since 2.0
 */
public interface Plugin {

    PluginConfiguration getConfig();

    /**
     * Unpack plugins files to specified output directory.
     *
     * @param outputDirectory the directory to unpack files to.
     * @deprecated deprecated, use {@link #getPluginFiles()} instead.
     */
    @Deprecated
    void unpackReportStatic(Path outputDirectory) throws IOException;

    /**
     * Returns the map of all plugin files. Keys are normalized file names relative to
     * plugins directory.
     *
     * @return the plugin files.
     */
    Map getPluginFiles();

    List getExtensions();


}