com.vaadin.flow.server.frontend.

Interface EndpointGeneratorTaskFactory

  • All Known Implementing Classes:

    EndpointGeneratorTaskFactoryImpl


    public interface EndpointGeneratorTaskFactory

    A factory for creating Vaadin Endpoint generator tasks.

    For internal use only. May be renamed or removed in a future release.

    Since:

    6.0

    Author:

    Vaadin Ltd.

    • Method Detail

      • createTaskGenerateFusion

        TaskGenerateFusion createTaskGenerateFusion(File applicationProperties,
                                            File openApi,
                                            File outputFolder,
                                            File frontendDirectory)

        Create a task for generating TS files based.

        Parameters:

        applicationProperties - application properties file.

        openApi - openApi json file. not null

        outputFolder - the output folder. not null

        frontendDirectory - the frontend folder.

        Returns:

        an endpoint tasks for generating TypeScript files for endpoints.

      • createTaskGenerateOpenAPI

        TaskGenerateOpenAPI createTaskGenerateOpenAPI(File properties,
                                              File javaSourceFolder,
                                              ClassLoader classLoader,
                                              File output)

        Create a task for generating OpenAPI spec.

        Parameters:

        properties - application properties file.

        javaSourceFolder - source paths of the project containing Vaadin Endpoint. not null

        classLoader - The class loader which should be used to resolved types in the source paths. not null

        output - the output path of the generated json file. not null

        Returns:

        an endpoint task that generates open api json file.

      • createTaskUseFusionPackage

        TaskUseFusionPackage createTaskUseFusionPackage(File npmFolder,
                                                File generatedPath,
                                                File flowResourcesPath,
                                                String buildDir)

        Create a task for populating the package.json with Fusion dependencies.

        Parameters:

        npmFolder - folder with the `package.json` file

        generatedPath - folder where flow generated files will be placed.

        flowResourcesPath - folder where flow dependencies will be copied to.

        buildDir - the used build directory

        Returns:

        an endpoint task that adds Fusion packages to a package.json file