open class EclipseWtpComponent
Enables fine-tuning wtp component details of the Eclipse plugin
Example of use with a blend of all possible properties. Bear in mind that usually you don't have to configure them directly because Gradle configures it for free!
apply plugin: 'war' //or 'ear' or 'java' apply plugin: 'eclipse-wtp' configurations { someInterestingConfiguration anotherConfiguration } eclipse { //if you want parts of paths in resulting file(s) to be replaced by variables (files): pathVariables 'GRADLE_HOME': file('/best/software/gradle'), 'TOMCAT_HOME': file('../tomcat') wtp { component { //you can configure the context path: contextPath = 'someContextPath' //you can configure the deployName: deployName = 'killerApp' //you can alter the wb-resource elements. //non-existing source dirs won't be added to the component file. sourceDirs += file('someExtraFolder') // dependencies to mark as deployable with lib folder deploy path libConfigurations += [ configurations.someInterestingConfiguration ] // dependencies to mark as deployable with root folder deploy path rootConfigurations += [ configurations.someInterestingConfiguration ] // dependencies to exclude from wtp deployment minusConfigurations << configurations.anotherConfiguration //you can add a wb-resource elements; mandatory keys: 'sourcePath', 'deployPath': //if sourcePath points to non-existing folder it will *not* be added. resource sourcePath: 'extra/resource', deployPath: 'deployment/resource' //you can add a wb-property elements; mandatory keys: 'name', 'value': property name: 'moodOfTheDay', value: ':-D' } } } beforeMerged and whenMerged closures receive WtpComponent object
Examples of advanced configuration:
apply plugin: 'war' apply plugin: 'eclipse-wtp' eclipse { wtp { component { file { //if you want to mess with the resulting XML in whatever way you fancy withXml { def node = it.asNode() node.appendNode('xml', 'is what I love') } //closure executed after wtp component file content is loaded from existing file //but before gradle build information is merged beforeMerged { wtpComponent -> //tinker with WtpComponent here } //closure executed after wtp component file content is loaded from existing file //and after gradle build information is merged whenMerged { wtpComponent -> //you can tinker with the WtpComponent here } } } } }
EclipseWtpComponent(project: Project, file: XmlFileContentMerger) |
open fun file(closure: Closure<Any>): Unit
Enables advanced configuration like tinkering with the output XML or affecting the way existing wtp component file content is merged with gradle build information The object passed to whenMerged{} and beforeMerged{} closures is of type WtpComponent For example see docs for EclipseWtpComponent open fun file(action: Action<in XmlFileContentMerger>): Unit
Enables advanced configuration like tinkering with the output XML or affecting the way existing wtp component file content is merged with gradle build information. For example see docs for EclipseWtpComponent |
|
open fun getClassesDeployPath(): String
The deploy path for classes. For examples see docs for EclipseWtp |
|
open fun getContextPath(): String
The context path for the web application For examples see docs for EclipseWtp |
|
open fun getDeployName(): String
The deploy name to be used. For examples see docs for EclipseWtp |
|
open fun getFile(): XmlFileContentMerger
See |
|
open fun getFileReferenceFactory(): FileReferenceFactory |
|
open fun getLibConfigurations(): MutableSet<Configuration>
The configurations whose files are to be marked to be deployed with a deploy path of For examples see docs for EclipseWtp |
|
open fun getLibDeployPath(): String
The deploy path for libraries. For examples see docs for EclipseWtp |
|
open fun getMinusConfigurations(): MutableSet<Configuration>
The configurations whose files are to be excluded from wtp deployment. For examples see docs for EclipseWtp |
|
open fun getPathVariables(): MutableMap<String, File>
The variables to be used for replacing absolute path in dependent-module elements. For examples see docs for EclipseModel |
|
open fun getPlusConfigurations(): MutableSet<Configuration>
Synonym for |
|
open fun getProject(): Project |
|
open fun getProperties(): MutableList<WbProperty>
Additional property elements. For examples see docs for EclipseWtp |
|
open fun getResources(): MutableList<WbResource>
Additional wb-resource elements. For examples see docs for EclipseWtp Only resources that link to an existing directory ( |
|
open fun getRootConfigurations(): MutableSet<Configuration>
The configurations whose files are to be marked to be deployed with a deploy path of '/'. For examples see docs for EclipseWtp |
|
open fun getSourceDirs(): MutableSet<File>
Source directories to be transformed into wb-resource elements. For examples see docs for EclipseWtp Only source dirs that exist will be added to the wtp component file. Non-existing resource directory declarations lead to errors when project is imported into Eclipse. |
|
open fun mergeXmlComponent(xmlComponent: WtpComponent): Unit |
|
open fun property(args: MutableMap<String, String>): Unit
Adds a property. For examples see docs for EclipseWtp |
|
open fun resource(args: MutableMap<String, String>): Unit
Adds a wb-resource. For examples see docs for EclipseWtp |
|
open fun setClassesDeployPath(classesDeployPath: String): Unit |
|
open fun setContextPath(contextPath: String): Unit |
|
open fun setDeployName(deployName: String): Unit |
|
open fun setLibConfigurations(libConfigurations: MutableSet<Configuration>): Unit |
|
open fun setLibDeployPath(libDeployPath: String): Unit |
|
open fun setMinusConfigurations(minusConfigurations: MutableSet<Configuration>): Unit |
|
open fun setPathVariables(pathVariables: MutableMap<String, File>): Unit |
|
open fun setPlusConfigurations(plusConfigurations: MutableSet<Configuration>): Unit
Synonym for |
|
open fun setProperties(properties: MutableList<WbProperty>): Unit |
|
open fun setResources(resources: MutableList<WbResource>): Unit |
|
open fun setRootConfigurations(rootConfigurations: MutableSet<Configuration>): Unit |
|
open fun setSourceDirs(sourceDirs: MutableSet<File>): Unit |