org.gradle.plugins.ide.eclipse.EclipseWtpPlugin.groovy Maven / Gradle / Ivy
/*
* Copyright 2011 the original author or authors.
*
* 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 org.gradle.plugins.ide.eclipse
import com.google.common.collect.Iterables
import groovy.transform.CompileStatic
import org.gradle.api.JavaVersion
import org.gradle.api.Project
import org.gradle.api.artifacts.Configuration
import org.gradle.api.internal.ConventionMapping
import org.gradle.api.internal.IConventionAware
import org.gradle.api.plugins.JavaPlugin
import org.gradle.api.plugins.JavaPluginConvention
import org.gradle.api.plugins.WarPlugin
import org.gradle.api.plugins.WarPluginConvention
import org.gradle.api.tasks.bundling.War
import org.gradle.internal.reflect.Instantiator
import org.gradle.plugins.ear.EarPlugin
import org.gradle.plugins.ear.EarPluginConvention
import org.gradle.plugins.ide.eclipse.model.AbstractClasspathEntry
import org.gradle.plugins.ide.eclipse.model.AbstractLibrary
import org.gradle.plugins.ide.eclipse.model.Classpath
import org.gradle.plugins.ide.eclipse.model.EclipseModel
import org.gradle.plugins.ide.eclipse.model.EclipseWtp
import org.gradle.plugins.ide.eclipse.model.Facet
import org.gradle.plugins.ide.eclipse.model.Facet.FacetType
import org.gradle.plugins.ide.eclipse.model.WbDependentModule
import org.gradle.plugins.ide.eclipse.model.WbModuleEntry
import org.gradle.plugins.ide.eclipse.model.WbResource
import org.gradle.plugins.ide.eclipse.model.WtpComponent
import org.gradle.plugins.ide.internal.IdePlugin
import javax.inject.Inject
@CompileStatic
class EclipseWtpPlugin extends IdePlugin {
static final String ECLIPSE_WTP_COMPONENT_TASK_NAME = "eclipseWtpComponent"
static final String ECLIPSE_WTP_FACET_TASK_NAME = "eclipseWtpFacet"
static final String WEB_LIBS_CONTAINER = 'org.eclipse.jst.j2ee.internal.web.container'
@Override
protected String getLifecycleTaskName() {
return "eclipseWtp"
}
private final Instantiator instantiator
@Inject
EclipseWtpPlugin(Instantiator instantiator) {
this.instantiator = instantiator
}
@Override protected void onApply(Project project) {
project.pluginManager.apply(EclipsePlugin)
def model = project.extensions.getByType(EclipseModel)
model.wtp = instantiator.newInstance(EclipseWtp, model.classpath)
lifecycleTask.description = 'Generates Eclipse wtp configuration files.'
cleanTask.description = 'Cleans Eclipse wtp configuration files.'
def delegatePlugin = project.plugins.getPlugin(EclipsePlugin)
delegatePlugin.lifecycleTask.dependsOn(lifecycleTask)
delegatePlugin.cleanTask.dependsOn(cleanTask)
configureEclipseProject(project)
configureEclipseWtpComponent(project, model)
configureEclipseWtpFacet(project, model)
// do this after wtp is configured because wtp config is required to update classpath properly
configureEclipseClasspath(project, model)
}
private void configureEclipseClasspath(Project project, EclipseModel eclipseModel) {
project.plugins.withType(JavaPlugin) {
List deleteWtpDependentModule = []
eclipseModel.classpath.file.whenMerged { Classpath classpath ->
if (hasWarOrEarPlugin(project)) {
return
}
Set minusFiles = (Set) eclipseModel.wtp.component.minusConfigurations*.files?.flatten() ?: project.files().files
Set libFiles = (Set) eclipseModel.wtp.component.libConfigurations*.files?.flatten() ?: project.files().files
for (AbstractLibrary entry in Iterables.filter(classpath.entries, AbstractLibrary)) {
if (minusFiles.contains(entry.library.file) || !libFiles.contains(entry.library.file)) {
// Mark this library as not required for deployment
entry.entryAttributes[AbstractClasspathEntry.COMPONENT_NON_DEPENDENCY_ATTRIBUTE] = ''
} else {
// '../' and '/WEB-INF/lib' both seem to be correct (and equivalent) values here
//this is necessary so that the depended upon projects will have their dependencies
// deployed to WEB-INF/lib of the main project.
entry.entryAttributes[AbstractClasspathEntry.COMPONENT_DEPENDENCY_ATTRIBUTE] = '../'
deleteWtpDependentModule << entry.path
}
}
}
eclipseModel.wtp.component.file.whenMerged { WtpComponent wtpComponent ->
if (hasWarOrEarPlugin(project)) {
return
}
wtpComponent.wbModuleEntries.removeAll { WbModuleEntry wbModule ->
wbModule instanceof WbDependentModule && deleteWtpDependentModule.any { lib -> ((WbDependentModule) wbModule).handle.contains(lib) }
}
}
}
project.plugins.withType(WarPlugin) {
eclipseModel.classpath.containers WEB_LIBS_CONTAINER
eclipseModel.classpath.file.whenMerged { Classpath classpath ->
for (entry in Iterables.filter(classpath.entries,AbstractLibrary)) {
//this is necessary to avoid annoying warnings upon import to Eclipse
//the .classpath entries can be marked all as non-deployable dependencies
//because the wtp component file declares the deployable dependencies
entry.entryAttributes[AbstractClasspathEntry.COMPONENT_NON_DEPENDENCY_ATTRIBUTE] = ''
}
}
}
}
private void configureEclipseWtpComponent(Project project, EclipseModel model) {
maybeAddTask(project, this, ECLIPSE_WTP_COMPONENT_TASK_NAME, GenerateEclipseWtpComponent) { GenerateEclipseWtpComponent task ->
//task properties:
task.description = 'Generates the Eclipse WTP component settings file.'
task.inputFile = project.file('.settings/org.eclipse.wst.common.component')
task.outputFile = project.file('.settings/org.eclipse.wst.common.component')
//model properties:
model.wtp.component = task.component
((IConventionAware)task.component).conventionMapping.map('deployName') { model.project.name }
project.plugins.withType(JavaPlugin) {
if (hasWarOrEarPlugin(project)) {
return
}
task.component.libConfigurations = [project.configurations.getByName('runtime')] as Set
task.component.minusConfigurations = [] as Set
task.component.classesDeployPath = "/"
task.component.libDeployPath = "../"
((IConventionAware)task.component).conventionMapping.map('sourceDirs') { getMainSourceDirs(project) }
}
project.plugins.withType(WarPlugin) {
task.component.libConfigurations = [project.configurations.getByName('runtime')] as Set
task.component.minusConfigurations = [project.configurations.getByName('providedRuntime')] as Set
task.component.classesDeployPath = "/WEB-INF/classes"
task.component.libDeployPath = "/WEB-INF/lib"
ConventionMapping convention = ((IConventionAware)task.component).conventionMapping
convention.map('contextPath') { ((War)project.tasks.getByName('war')).baseName }
convention.map('resources') { [new WbResource('/', project.getConvention().getPlugin(WarPluginConvention).webAppDirName)] }
convention.map('sourceDirs') { getMainSourceDirs(project) }
}
project.plugins.withType(EarPlugin) {
task.component.rootConfigurations = [project.configurations.getByName('deploy')] as Set
task.component.libConfigurations = [project.configurations.getByName('earlib')] as Set
task.component.minusConfigurations = [] as Set
task.component.classesDeployPath = "/"
task.component.libDeployPath = "/lib"
((IConventionAware)task.component).conventionMapping.map('sourceDirs') {
[project.file { project.getConvention().getPlugin(EarPluginConvention).appDirName }] as Set
}
project.plugins.withType(JavaPlugin) {
((IConventionAware)task.component).conventionMapping.map('sourceDirs') { getMainSourceDirs(project) }
}
}
}
}
private void configureEclipseWtpFacet(Project project, EclipseModel eclipseModel) {
maybeAddTask(project, this, ECLIPSE_WTP_FACET_TASK_NAME, GenerateEclipseWtpFacet) { GenerateEclipseWtpFacet task ->
//task properties:
task.description = 'Generates the Eclipse WTP facet settings file.'
task.inputFile = project.file('.settings/org.eclipse.wst.common.project.facet.core.xml')
task.outputFile = project.file('.settings/org.eclipse.wst.common.project.facet.core.xml')
//model properties:
eclipseModel.wtp.facet = task.facet
project.plugins.withType(JavaPlugin) {
if (hasWarOrEarPlugin(project)) {
return
}
((IConventionAware)task.facet).conventionMapping.map('facets') {
[new Facet(FacetType.fixed, "jst.java", null), new Facet(FacetType.installed, "jst.utility", "1.0"),
new Facet(FacetType.installed, "jst.java", toJavaFacetVersion(project.convention.getPlugin(JavaPluginConvention).sourceCompatibility))]
}
}
project.plugins.withType(WarPlugin) {
((IConventionAware)task.facet).conventionMapping.map('facets') {
[new Facet(FacetType.fixed, "jst.java", null), new Facet(FacetType.fixed, "jst.web", null),
new Facet(FacetType.installed, "jst.web", "2.4"), new Facet(FacetType.installed, "jst.java", toJavaFacetVersion(project.convention.getPlugin(JavaPluginConvention).sourceCompatibility))]
}
}
project.plugins.withType(EarPlugin) {
((IConventionAware)task.facet).conventionMapping.map('facets') {
[new Facet(FacetType.fixed, "jst.ear", null), new Facet(FacetType.installed, "jst.ear", "5.0")]
}
}
}
}
private void maybeAddTask(Project project, IdePlugin plugin, String taskName, Class taskType, Closure action) {
if (project.tasks.findByName(taskName)) {
return
}
def task = project.tasks.create(taskName, taskType)
project.configure(task, action)
plugin.addWorker(task)
}
private void configureEclipseProject(Project project) {
def configureClosure = {
project.tasks.withType(GenerateEclipseProject) { GenerateEclipseProject task ->
task.projectModel.buildCommand 'org.eclipse.wst.common.project.facet.core.builder'
task.projectModel.buildCommand 'org.eclipse.wst.validation.validationbuilder'
task.projectModel.natures 'org.eclipse.wst.common.project.facet.core.nature'
task.projectModel.natures 'org.eclipse.wst.common.modulecore.ModuleCoreNature'
task.projectModel.natures 'org.eclipse.jem.workbench.JavaEMFNature'
}
}
project.plugins.withType(JavaPlugin, configureClosure)
project.plugins.withType(EarPlugin, configureClosure)
}
private boolean hasWarOrEarPlugin(Project project) {
project.plugins.hasPlugin(WarPlugin) || project.plugins.hasPlugin(EarPlugin)
}
private Set getMainSourceDirs(Project project) {
project.getConvention().getPlugin(JavaPluginConvention).sourceSets.getByName('main').allSource.srcDirs as LinkedHashSet
}
private String toJavaFacetVersion(JavaVersion version) {
if (version == JavaVersion.VERSION_1_5) {
return '5.0'
}
if (version == JavaVersion.VERSION_1_6) {
return '6.0'
}
return version.toString()
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy