com.intershop.gradle.icm.project

Class PluginConfig

com.intershop.gradle.icm.project.PluginConfig

public class PluginConfig

This class provides methods and configurations tasks for the project plugin.

Constructor Detail

PluginConfig

public PluginConfig(@NotNull
                    org.gradle.api.Project project,
                    @NotNull
                    org.gradle.api.file.ProjectLayout projectLayout)

This class provides methods and configurations tasks for the project plugin.

Parameters:

project - project of project plugin

projectLayout - project layout service

Method Detail

get3rdPartyCopyTask

@NotNull
public org.gradle.api.tasks.Sync get3rdPartyCopyTask(@NotNull
                                                              TaskConfCopyLib taskconf)

Configures the 3rd party copy task from an enumeration.

Parameters:

taskconf - enumeration with all necessary parameters

Returns:

Sync task

getSetupCartridgesTask

@NotNull
public SetupCartridges getSetupCartridgesTask(@NotNull
                                                       EnvironmentType type,
                                                       @NotNull
                                                       java.util.List<? extends com.intershop.gradle.icm.utils.EnvironmentType> environmentTypesList)

Configures the task for the setup of external cartridges.

Parameters:

type - environment type

environmentTypesList - List of environment types

getSitesTask

@NotNull
public CreateSitesFolder getSitesTask(@NotNull
                                               EnvironmentType type)

Configures the task for the sites folder creation.

Parameters:

type - environment type

getConfigTask

@NotNull
public CreateConfigFolder getConfigTask(@NotNull
                                                 CreateServerInfo versionInfoTask,
                                                 @NotNull
                                                 EnvironmentType type,
                                                 @NotNull
                                                 java.util.List<? extends com.intershop.gradle.icm.utils.EnvironmentType> environmentTypesList)

Configures the task for the configuration folder creation.

Parameters:

versionInfoTask - task that creates the server info

type - environment type

environmentTypesList - list of environment types for the configuration

configureInitTask

public void configureInitTask(@NotNull
                              CreateSitesFolder sitesFolderTask,
                              @NotNull
                              java.lang.String taskname)

Configures an existing package task - initalization package.

Parameters:

sitesFolderTask - creates the sites folder

taskname - specify the task name of the package folder

configurePackageTask

public void configurePackageTask(@NotNull
                                 CreateConfigFolder configTask,
                                 @NotNull
                                 SetupCartridges cartridgesTask,
                                 @NotNull
                                 org.gradle.api.tasks.Sync copyLibs,
                                 @NotNull
                                 java.lang.String taskname)

Configures an existing package task package.

Parameters:

configTask - creates the configuration folder

cartridgesTask - creates the folder with external cartridges

copyLibs - copy 3rd party libs

taskname - specify the task name of the package folder

configurePrepareTask

@NotNull
public org.gradle.api.Task configurePrepareTask(@NotNull
                                                         EnvironmentType type)

Configures the main task for the preparation.

Parameters:

type - environment type

getTask

@NotNull
public org.gradle.api.Task getTask(@NotNull
                                            java.lang.String taskname)

Get task from task container by name.

Parameters:

taskname - name of the task

getLibFilterFile

@NotNull
public ProvideLibFilter getLibFilterFile()

Get lib filter file task.

getProject

@NotNull
public org.gradle.api.Project getProject()

project of project plugin

getProjectLayout

@NotNull
public org.gradle.api.file.ProjectLayout getProjectLayout()

project layout service