Introduction

References

• Concept - Gradle Build Tools

• Cookbook - Gradle Build Tools

• Gradle Userguide    

• Gradle Build Language Reference (DSL)

• Gadle Java Documentation

Extension Objects

Gradle itself as well as its plugins use extension objects to obtain configurations from build scripts. Besides the standard extension objects of Gradle the Intershop build tools add some Intershop specific extension objects, that are discussed in this section.

Extension Object intershop

This extension contains the configuration of how to package artifacts of a component and other special component configurations. It comes with the intershop-base plugin. All component specific plugins applies the intershop-base plugin.

intershop {
	displayName = 'Platform - Messaging Component'
	staticLibs = fileTree(dir: staticCartridgeLibFolder, include: '*.jar')
}

Methods

Property Details

Type  ComponentPackage

A component package describes a package artifact that is part of a component and extends PatternSet. For more properties and methods see PatternSet.

intershop {
    packages {
        local { 
            srcDir fileTree(dir:'staticfiles/general', include: 'tools/**')
            srcDir(jar.outputs.files, {
						into 'tools/customer_tool'
						rename { String fileName ->
							fileName = 'customer_tool.jar'
						}
					})
        }
        share { }
    }
}

The following packages are preconfigured. If the package is added the preconfiguration is used.

Methods

Property Details

Extension Object jaxb (deprecated with Gradle Tools version 2.11.5)

This extension comes with the jaxb plugin. This plugin is automatically applied by the intershop-javabase plugin. With this extension the JAXB code generation is configured. For each configuration a jaxb task will be created.

Both examples generate the Java files of bc_mvc JAXB configuration.

jaxb {
    configs {
        bc_mvc {
            xsd = 'staticfiles/definition/bc_mvc.xsd'
            xjb = 'staticfiles/definition/bc_mvc.xjb'
        }
    }
}

jaxb {
    configs {
        bc_mvc {
            dir = 'staticfiles/definition'
        }
    }
}

Methods

Property Details

Type JaxbConfig

This type describes a special Jaxb configuration.

Property Details

The following configurations of input files are valid:

• Schema description file (xsd is specified)
• Schema description file and JAXB binding file (xsd and xjb is specified)
• An directory path
  This folder contains schema description files and JAXB binding files (only dir is specified).

Extension Object jaxbSchemaGen (deprecated with Gradle Tools version 2.11.5)

This extension comes with the jaxbSchemaGen plugin. This plugin is automatically applied by the intershop-javabase plugin. With this extension the JAXB schema generation is configured. For each configuration a jaxbSchemaGen task will be created.

The example generates the schema file of ac_order_status_import_xml.

jaxbSchemaGen {
    configs {
        acorder {
            includes   = 'com/intershop/adapter/orderstatusimport/xml/binding/*.java'
            xsd        = 'share/system/impex/schema/ac_order_status_import_xml.xsd'
            namespace  = 'http://www.intershop.com/xml/ns/intershop/order/status/1.0'
        }
    }
}

Methods

Property Details

Type JaxbSchemaGenConfig

This type describes a special JaxbSchemaGen configuration.

Property Details

The following configuration of input files is valid:

• Schema description file, include pattern and namespace (xsd, includes and namespace are specified)

Extension Object wsdl (deprecated with Gradle Tools version 2.11.6)

This extension comes with the wsdl plugin. This plugin is automatically applied by the intershop-javabase plugin. With this extension the WSDL code generation will be configured. For each configuration a wsdl2java task will be created.

wsdl {
    axis1Configs {
        processWebObjects {
            wsdlFile = 'staticfiles/wsdl/ProcessWebObjects.wsdl'
            packageName = 'com.intershop.beehive.core.capi.staging.webservice'
        }
    }
}

wsdl {
    axis1Configs {
        echoWebService {
            wsdlFile = 'staticfiles/wsdl/EchoWebService.wsdl'
            packageName = 'tests.server.com.intershop.beehive.core.internal.webservice.client'
        }
    }
    axis2Configs {
        addNumbersService {
            wsdlFile = 'staticfiles/wsdl/AddNumbersService.wsdl'
            packageName = 'tests.server.com.intershop.beehive.core.internal.axis2.additionservice.client'
        }
    }
}

Methods  

Property Details  

Type Axis1Config

This type describes a special Axis 1 configuration.

Property Details

Type Axis2Config 

This type describes a special Axis 2 configuration.

Property Details

Extension Object isml (deprecated with Gradle Tools version 2.11.6)  

  This extension comes with the isml plugin. This plugin is automatically applied by the static-cartridge plugin. With this extension ISML templates will be compiled. For each configuration a isml2class task will be created.  

isml {
	main {
		ismlPath = 'staticfiles/cartridge/templates'
		compileClasspath = sourceSets.main.compileClasspath + sourceSets.main.output
	}
}

Methods  

Property Details

Type IsmlSourceSet

Property Details 

There is one IsmlSourceSet main preconfigured for this plugin.

Extension Object tloc (deprecated with Gradle Tools version 2.3)

This extension comes with the tlocplugin. This plugin is automatically applied by the static-cartridge plugin. With this extension ISML templates will be localized if a special dictionary file is available. For each localization a tloc tasks will be created and an ISML source set tloc_<language code> is added to the list of ISML source sets, if the ISML plugin is applied. This tool should also be used during the development process (see TLoc documntation).

tloc {
    languages {
        de_De { }
    }
}

Methods

Type IsmlSourceSet

Property Details   

Extension Object javacc (deprecated with Gradle Tools version 2.11.5)

This extension comes with the javacc plugin. This plugin is automatically applied by the intershop-javabase plugin.

javacc {
    configs {
        ismlParser {
            inputFile = 'javasource/com/intershop/beehive/isml/internal/parser/ISMLparser.jj'
            outputPath = 'com/intershop/beehive/isml/internal/parser'
            javaUnicodeEscape = true
            ignoreCase = true
        }
    }
}

javacc {
    configs {
        oPExpression {
            inputFile = 'javasource/com/intershop/beehive/core/internal/opexpression/parser/OPExpressionGrammar.jjt'
            outputPath = 'com/intershop/beehive/core/internal/opexpression/parser'
            jdkVersion = '1.4'
            javaUnicodeEscape = true
            ignoreCase = true
            jjtree {
                visitor = true
                nodePrefix = ''
                nodeExtends = 'com.intershop.beehive.core.internal.opexpression.parser.SuperNode'
            }
        }
    }
}

Methods  

Property Details

Type JavaccConfig

For more details of JavaCC you can find in the JavaCC documentation.

Methods    

Property Details

void CommonTokenAction(Token t)

Type JJTree

For more details see JJTree Reference Documentation.

Property Details

Extension Object resourcelist (deprecated with Gradle Tools version 2.11.5)

This extension comes with the resourcelist plugin. This plugin is automatically applied by the javabase-cartridge plugin. The following configurations will be created by the plugin:

resourcelist {
	lists {
		orm {
			source sourceSets.main.allSource.getSrcDirs()
			include '**/**/*.orm'
			resourceListFile = new File(sourceSets.main.output.getResourcesDir(), "resources/${project.name}/orm/orm.resource")
		}
		pipelets {
			source sourceSets.main.allSource.getSrcDirs()
			include '**/pipelet/**/*.xml'
			exclude '**/*_??_??.xml'
			resourceListFile = new File(sourceSets.main.output.getResourcesDir(), "resources/${project.name}/pipeline/pipelets.resource")
		}
	}
}

Methods  

Type ListConfiguration      

A ListConfiguration describes a resource list generation and extends PatternSet. For more properties and methods see PatternSet.

Methods  

  Property Details  

Extension Object sonarqube (deprecated with Gradle Tools version 2.7)

This extension comes with the intershop-sonar plugin.

Methods

Property Details 

Plugins

Plugin intershop-base

This plugin add the Intershop extension to the project. The following plugins will be applied with this plugin: base, java-base and ivy-publish. For more information see Standard Gradle plugins . This plugin will change or add some configurations:

creates the SourceSet main

extend classpath with internal liberaries from the source folder staticfiles/cartridge/lib

changes the behavior of the compile configuration to non transitive

additional artifacts of an Intershop component are pre-configured in this plugin (see Reference - Gradle Build Tools#ComponentPackage).

add an Intershop component configuration for publishing (see Gradle documentation): components.intershop

add an IVY publishing configuration for Intershop components

The workflow of tasks will be not changed by this plugin. All tasks and the workflow is implemented by standard Gradle cartridges.

Plugin cartridge-base

This plugin applies the plugin Reference - Gradle Build Tools#intershop-base. A component, that is installed in the Intershop cartridge folder, includes always an artifact for the shared file system. Therefore the artifact share is added by this plugin (see Reference - Gradle Build Tools#ComponentPackage).

Plugin intershop-javabase

This plugin applies the plugin Reference - Gradle Build Tools#intershop-base. Plugins for some special code generation are also applied by this plugins:

jaxb plugin

wsdl plugin

javacc plugin

Reference - Gradle Build Tools#intershop-sonar plugin

This plugin will change or add some configurations:

Add Reference - Gradle Build Tools#javaSourceDir of the Intershop extension as a source directory to SourceSet main.

SourceSet test is created and Reference - Gradle Build Tools#javaSourceDir of the Intershop extension as a source directory is added. Furthermore the the include and exclude is changed.

sourceSets {
	main {
    	java {
			srcDir project.extensions.intershop.javaSourceDir
      		include '**/**/*.java'
    	}
		resources {
			srcDir project.extensions.intershop.javaSourceDir
			include '**/**/**'
      		exclude '**/**/*.java'
		}
  	}
	test {
		java {
			srcDir project.extensions.intershop.javaSourceDir
      		include 'tests/**/**'
			exclude 'tests/server/**/*.java'
			exclude 'tests/unit/**/*.java'		
		}
	}
}

The classpaths of the compile configuration of main and the runtime configuration test are extended.

The following configurations are added: testRuntime, testCompile, source and javadoc.

This plugin adds also some tasks: test and jar<SourceSet name>.

Workflow

Plugin intershop-java

This plugin applies the Reference - Gradle Build Tools#intershop-javabase plugin. It extends the IVY publishing of the jar file. Furthermore the javadoc task is added to the workflow.

Plugin javabase-component

This plugin applies the Reference - Gradle Build Tools#intershop-javabase plugin. It changes the configuration of the SourceSet main.

sourceSets {
	main {
    	java {
			exclude 'tests/**/**'
    	}
		resources {
      		exclude 'tests/**/**'
		}
  	}
}

Plugin java-component

This plugin applies the Reference - Gradle Build Tools#intershop-java plugin. It changes the configuration of the SourceSet main (see Reference - Gradle Build Tools#javabase-component).

Plugin javabase-cartridge

This plugin applies Reference - Gradle Build Tools#cartridge-base, Reference - Gradle Build Tools#intershop-java and resourcelist plugin. The configuration of the compiler is extended for annotation processing.

If the project.extensions.intershop.compilerWarningsEnabled is true the following compiler options are added:

'-Xlint:deprecation'

'-Xlint:unchecked'

'-Xlint:path'

Plugin java-cartridge

This plugin applies Reference - Gradle Build Tools#javabase-cartridge.

The following additional artifacts will be added:

if the value of project property releaseWithSources is true, the source package will be created

if the value of project property releaseWithJavaDoc is true, the javadoc package will be created

The default value of both properties is false. If the properties are true, tasks will be added to the workflow - javadoc will be executed before the packaging starts.

Plugin static-component

This plugin applies Reference - Gradle Build Tools#intershop-base plugin without any changes. This is a place holder for further versions.

Plugin static-cartridge

This plugin applies Reference - Gradle Build Tools#cartridge-base, tloc and isml plugin. This plugin adds also the 'cartridge' additional package.

Workflow

Plugin test-cartridge

This plugin is currently identical to Reference - Gradle Build Tools#javabase-cartridge. This is a place holder for further versions.

Plugin lib-cartridge (deprecated with Gradle Tools 2.11.5)

This plugin applies the Reference - Gradle Build Tools#javabase-cartridge plugin without any other changes. It adds also the Task check, if this is not available in the task list. This is necessary for a "library" cartridge - a cartridge that contains only other libraries.

This kind of cartridges is deprecated, please use standard Gradle dependencies instead.

Plugin tool-cartridge (deprecated with Gradle Tools 2.11.5)

This plugin applies the Reference - Gradle Build Tools#intershop-java plugin. This is necessary for a "tools" cartridge - a cartridge that contains only other libraries. The additional jar file contains an entry in the manifest of the jar. This extends the classpath and is necessary for some tools.

This kind of cartridges is deprecated, please use standard Gradle dependencies instead.

Plugin jaxb (deprecated with Gradle Tools 2.11.5)

This plugin adds the jaxb extension. This plugin adds the JAXB code generation to the Intershop build plugins.
Please use the public available 'Jaxb code generator plugin' (jaxb-gradle-plugin). 

Plugin jaxbSchemaGen (deprecated with Gradle Tools 2.11.5)

This plugin adds jaxbSchemaGen extension. This plugin adds the JAXB schema generator to the Intershop build plugins.
Please use the public available 'Jaxb code generator plugin' (jaxb-gradle-plugin). 

Plugin wsdl (deprecated with Gradle Tools 2.11.6)

This plugin adds the wsdl extension. This plugin adds the WSDL code generation for Axis and Axis 2 to the Intershop build plugins.

Plugin javacc (deprecated with Gradle Tools 2.11.5)

This plugin adds the javacc extension. This plugin adds the JavaCC code generation to the Intershop build plugins.
Please use the public available 'WSDL code generator plugin' (wsdl-gradle-plugin).

Plugin intershop-sonar (deprecated with Gradle Tools 2.11.5)

This plugin adds the sonarqube extension. This plugin adds the Sonar code analyses to the Intershop build plugins. The task run the Sonar starter library and starts a separate Java process.
This plugin is deprecated, please use (sonarqube-gradle-plugin) or the standard Plugin from SonarQube.  

Plugin resourcelist (deprecated with Gradle Tools 2.11.5)

This plugin adds the resourcelist extension. This plugin adds the resourcelist generation to the Intershop build plugins.
Please use the public available 'ResourceList generator plugin' (resourcelist-gradle-plugin).

Plugin tloc (deprecated with Gradle Tools 2.3)

This plugin adds the tloc extension. This plugin add the ISML localization template generation to the Intershop build plugins. For the generated ISML templates the ISML configuration will be extended. An additional ISML source set is added.

Plugin isml (deprecated with Gradle Tools 2.11.6)

This plugin adds the isml extension. This plugin pre-compiles ISML templates.