Package com.vaadin.flow.plugin.base

Interface PluginAdapterBase

  • All Known Subinterfaces:
    PluginAdapterBuild
    public interface PluginAdapterBase
    Gives access to access to plugin-spectific implementations and configurations.

    • Method Detail

      • applicationProperties

        File applicationProperties()
        Application properties file in Spring project.
        Returns:
        File applicationProperties

      • createLookup

        default Lookup createLookup​(ClassFinder classFinder)
        Creates a Lookup for the ClassFinder.
        Parameters:
        classFinder - implementation that will be registered for the serviceTxpe `ClassFinder`.
        Returns:
        Lookup

      • eagerServerLoad

        boolean eagerServerLoad()
        Whether or not insert the initial Uidl object in the bootstrap index.html.
        Returns:
        boolean

      • frontendDirectory

        File frontendDirectory()
        A directory with project's frontend source files.
        Returns:
        File

      • generatedFolder

        File generatedFolder()
        The folder where flow will put generated files that will be used by webpack.
        Returns:
        File

      • generatedTsFolder

        File generatedTsFolder()
        The folder where flow will put TS API files for client projects.
        Returns:
        File

      • getJarFiles

        Set<File> getJarFiles()
        The Jar Files that would be searched.
        Returns:
        Set of File

      • isJarProject

        boolean isJarProject()
        Indicates that it is a Jar Project.
        Returns:
        boolean - indicates that it is a Jar Project

      • getUseDeprecatedV14Bootstrapping

        String getUseDeprecatedV14Bootstrapping()
        Whether or not we are running in legacy V14 bootstrap mode. True if defined or if it's set to true.
        Returns:
        String

      • isDebugEnabled

        boolean isDebugEnabled()
        Checks the debug Mode.
        Returns:
        boolean

      • isUseDeprecatedV14Bootstrapping

        default boolean isUseDeprecatedV14Bootstrapping()
        Check if the plugin is running in legacy V14 bootstrap mode or not. Default: false.
        Returns:
        true if the `useDeprecatedV14Bootstrapping` is empty or true.

      • javaSourceFolder

        File javaSourceFolder()
        Java source folders for scanning.
        Returns:
        File

      • javaResourceFolder

        File javaResourceFolder()
        Java resource folder.
        Returns:
        File

      • logDebug

        void logDebug​(CharSequence debugMessage)
        Delegates a debug-Message to a logger.
        Parameters:
        debugMessage - to be logged.

      • logInfo

        void logInfo​(CharSequence infoMessage)
        Delegates a info-Message to a logger.
        Parameters:
        infoMessage - to be logged.

      • logWarn

        void logWarn​(CharSequence warningMessage)
        delegates a warning-Message to a logger.
        Parameters:
        warningMessage - to be logged.

      • logWarn

        void logWarn​(CharSequence warningMessage,
             Throwable throwable)
        Delegates a warning-Message to a logger.
        Parameters:
        warningMessage - to be logged.
        throwable - to be logged.

      • logError

        void logError​(CharSequence warning,
              Throwable e)
        Delegates a error-Message to a logger.
        Parameters:
        warning - to be logged.
        e - to be logged.

      • nodeDownloadRoot

        URI nodeDownloadRoot()
              throws URISyntaxException
        Download node.js from this URL. Handy in heavily firewalled corporate environments where the node.js download can be provided from an intranet mirror. Defaults to null which will cause the downloader to use NodeInstaller.DEFAULT_NODEJS_DOWNLOAD_ROOT.

        Example: "https://nodejs.org/dist/".

        Returns:
        nodeDownloadRoot
        Throws:
        URISyntaxException - - Could not build an URI from nodeDownloadRoot().

      • nodeAutoUpdate

        boolean nodeAutoUpdate()
        Whether the alternative node may be autoupdated or not.
        Returns:
        true to update node if older than default

      • nodeVersion

        String nodeVersion()
        The node.js version to be used when node.js is installed automatically by Vaadin, for example `"v12.18.3"`. Defaults to null which uses the Vaadin-default node version - see FrontendTools for details.
        Returns:
        node Verrsion as String

      • npmFolder

        File npmFolder()
        The folder where `package.json` file is located. Default is project root dir.
        Returns:
        boolean

      • openApiJsonFile

        File openApiJsonFile()
        Default generated path of the OpenAPI json.
        Returns:
        boolean

      • pnpmEnable

        boolean pnpmEnable()
        Instructs to use pnpm for installing npm frontend resources.
        Returns:
        boolean

      • useGlobalPnpm

        boolean useGlobalPnpm()
        Instructs to use globally installed pnpm tool or the default supported pnpm version.
        Returns:
        boolean

      • productionMode

        boolean productionMode()
        Whether or not we are running in productionMode.
        Returns:
        boolean

      • projectBaseDirectory

        Path projectBaseDirectory()
        The projects root Directory.
        Returns:
        Path

      • requireHomeNodeExec

        boolean requireHomeNodeExec()
        Whether vaadin home node executable usage is forced. If it's set to true then vaadin home 'node' is checked and installed if it's absent. Then it will be used instead of globally 'node' or locally installed installed 'node'.
        Returns:
        boolean

      • servletResourceOutputDirectory

        File servletResourceOutputDirectory()
        Defines the output directory for generated non-served resources, such as the token file.
        Returns:
        File

      • webpackOutputDirectory

        File webpackOutputDirectory()
        The folder where webpack should output index.js and other generated files.
        Returns:
        File

      • buildFolder

        String buildFolder()
        The folder where everything is built into.
        Returns:
        build folder

      • postinstallPackages

        List<String> postinstallPackages()
        Additional npm packages to run postinstall for.
        Returns:
        a list of packages