CXF Codegen User Guide

plugins {
    id "java"
    id "io.mateo.cxf-codegen" version "1.2.1"
}

plugins {
    java
    id("io.mateo.cxf-codegen") version "1.2.1"
}

cxfCodegen { (1)

}

cxfCodegen { (1)

}

import io.mateo.cxf.codegen.wsdl2java.Wsdl2Java

// ...

tasks.register("example", Wsdl2Java) { (1)
    toolOptions { (2)
        wsdl.set(file("path/to/example.wsdl")) (3)
    }
    allJvmArgs = ["-Duser.language=fr", "-Duser.country=CA"] (4)
}

import io.mateo.cxf.codegen.wsdl2java.Wsdl2Java

// ...

tasks.register("example", Wsdl2Java::class) { (1)
    toolOptions { (2)
        wsdl.set(file("path/to/example.wsdl")) (3)
    }
    allJvmArgs = listOf("-Duser.language=fr", "-Duser.country=CA") (4)
}

tasks.register("example", Wsdl2Java) {
    toolOptions {
        wsdl.set(file("path/to/example.wsdl"))
        outputDir.set(file("$buildDir/generated-java")) (1)
        markGenerated.set(true) (2)
        packageNames.set(["com.example", "com.foo.bar"]) (3)
        asyncMethods.set(["foo", "bar"]) (4)
    }
}

tasks.register("example", Wsdl2Java::class) {
    toolOptions {
        wsdl.set(file("path/to/example.wsdl"))
        outputDir.set(file("$buildDir/generated-java")) (1)
        markGenerated.set(true) (2)
        packageNames.set(listOf("com.example", "com.foo.bar")) (3)
        asyncMethods.set(listOf("foo", "bar")) (4)
    }
}

tasks.register("first", Wsdl2Java) {
    toolOptions {
        wsdl.set(file("path/to/first.wsdl"))
    }
}
tasks.register("second", Wsdl2Java) {
    toolOptions {
        wsdl.set(file("path/to/second.wsdl"))
    }
}
tasks.register("third", Wsdl2Java) {
    toolOptions {
        wsdl.set(file("path/to/third.wsdl"))
    }
}

tasks {
    register("first", Wsdl2Java::class) {
        toolOptions {
            wsdl.set(file("path/to/first.wsdl"))
        }
    }
    register("second", Wsdl2Java::class) {
        toolOptions {
            wsdl.set(file("path/to/second.wsdl"))
        }
    }
    register("third", Wsdl2Java::class) {
        toolOptions {
            wsdl.set(file("path/to/third.wsdl"))
        }
    }
}

tasks.withType(Wsdl2Java).configureEach {
    toolOptions {
        markGenerated.set(true)
    }
}

tasks.withType(Wsdl2Java::class).configureEach {
    toolOptions {
        markGenerated.set(true)
    }
}

dependencies {
    cxfCodegen "jakarta.xml.ws:jakarta.xml.ws-api:2.3.3" (1)
    cxfCodegen "jakarta.annotation:jakarta.annotation-api:1.3.5" (2)
}

dependencies {
    cxfCodegen("jakarta.xml.ws:jakarta.xml.ws-api:2.3.3") (1)
    cxfCodegen("jakarta.annotation:jakarta.annotation-api:1.3.5") (2)
}

repositories {
    mavenCentral()
}

cxfCodegen {
    cxfVersion = "4.0.0" (1)
}

dependencies {
    cxfCodegen "jakarta.xml.ws:jakarta.xml.ws-api:4.0.0" (2)
    cxfCodegen "jakarta.annotation:jakarta.annotation-api:2.1.1"
}

repositories {
    mavenCentral()
}

cxfCodegen {
    cxfVersion.set("4.0.0") (1)
}

dependencies {
    cxfCodegen("jakarta.xml.ws:jakarta.xml.ws-api:4.0.0") (2)
    cxfCodegen("jakarta.annotation:jakarta.annotation-api:2.1.1")
}

dependencies {
    cxfCodegen "ch.qos.logback:logback-classic:1.2.10"
}

dependencies {
    cxfCodegen("ch.qos.logback:logback-classic:1.2.10")
}

import io.mateo.cxf.codegen.wsdl2js.Wsdl2Js

// ...

tasks.register("example", Wsdl2Js) { (1)
    toolOptions { (2)
        wsdl.set(file("path/to/example.wsdl").absolutePath) (3)
    }
}

import io.mateo.cxf.codegen.wsdl2js.Wsdl2Js

// ...

tasks.register("example", Wsdl2Js::class) { (1)
    toolOptions { (2)
        wsdl.set(file("path/to/example.wsdl").absolutePath) (3)
    }
}

tasks.register("example", Wsdl2Js) {
    toolOptions {
        wsdl.set(file("path/to/example.wsdl").absolutePath)
        outputDir.set(file("$buildDir/example-generated-js")) (1)
        catalog.set(file("path/to/example-catalog.xml")) (2)
        packagePrefixes.set([new UriPrefixPair("https://example.com", "example")]) (3)
        verbose.set(true) (4)
    }
}

tasks.register("example", Wsdl2Js::class) {
    toolOptions {
        wsdl.set(file("path/to/example.wsdl").absolutePath)
        outputDir.set(file("$buildDir/example-generated-js")) (1)
        catalog.set(file("path/to/example-catalog.xml")) (2)
        packagePrefixes.set(listOf(UriPrefixPair("https://example.com", "example"))) (3)
        verbose.set(true) (4)
    }
}

import io.mateo.cxf.codegen.wsdl2java.Wsdl2Java

// ...

tasks.register("calculator", Wsdl2Java) {
    toolOptions {
        wsdl.set(layout.projectDirectory.file("calculator.wsdl"))
        bindingFiles.add(layout.projectDirectory.file("async-binding.xml").asFile.absolutePath) (1)
    }
}

import io.mateo.cxf.codegen.wsdl2java.Wsdl2Java

// ...

tasks.register("calculator", Wsdl2Java::class) {
    toolOptions {
        wsdl.set(layout.projectDirectory.file("calculator.wsdl"))
        bindingFiles.add(layout.projectDirectory.file("async-binding.xml").asFile.absolutePath) (1)
    }
}

import io.mateo.cxf.codegen.wsdl2java.Wsdl2Java

dependencies {
    cxfCodegen "org.apache.cxf:cxf-rt-databinding-jibx:3.1.18" (1)
}

// ...

tasks.register("calculator", Wsdl2Java) {
    toolOptions {
        wsdl.set(layout.projectDirectory.file("calculator.wsdl"))
        extraArgs.addAll(["-databinding", "jibx"]) (2)
    }
}

import io.mateo.cxf.codegen.wsdl2java.Wsdl2Java

dependencies {
    cxfCodegen("org.apache.cxf:cxf-rt-databinding-jibx:3.1.18") (1)
}

// ...

tasks.register("calculator", Wsdl2Java::class) {
    toolOptions {
        wsdl.set(layout.projectDirectory.file("calculator.wsdl"))
        extraArgs.addAll(listOf("-databinding", "jibx")) (2)
    }
}

import io.mateo.cxf.codegen.wsdl2java.Wsdl2Java

// ...

tasks.register("calculator", Wsdl2Java) {
    toolOptions {
        wsdl.set(layout.projectDirectory.file("calculator.wsdl"))
        serviceName.set("Calculator") (1)
    }
}

import io.mateo.cxf.codegen.wsdl2java.Wsdl2Java

// ...

tasks.register("calculator", Wsdl2Java::class) {
    toolOptions {
        wsdl.set(layout.projectDirectory.file("calculator.wsdl"))
        serviceName.set("Calculator") (1)
    }
}

import io.mateo.cxf.codegen.wsdl2java.Wsdl2Java

configurations {
    myConfiguration (1)
}

dependencies {
    myConfiguration "org.apache.cxf:cxf-testutils:3.5.3" (2)
}

def copyArtifact = tasks.register("copyArtifact", Copy) { (3)
    from(configurations.myConfiguration) {
        include {
            it.name.startsWith("cxf-testutils")
        }
    }
    into(layout.buildDirectory.dir("copied-artifact"))
}

def extractWsdl = tasks.register("extractWsdl") { (4)
    def wsdlFile = layout.buildDirectory.file("extracted.wsdl")
    inputs.files(copyArtifact)
    outputs.file(wsdlFile)
    doLast {
        // Assumes single JAR artifact from previous task
        def list = []
        inputs.files.singleFile.eachFileRecurse(groovy.io.FileType.FILES) { f -> list.add(f) }
        def archive = list.first()
        def textResource = resources.text.fromArchiveEntry(archive, "wsdl/calculator.wsdl")
        def f = wsdlFile.get().asFile
        f.createNewFile()
        f.write(textResource.asString())
    }
}

tasks.register("calculator", Wsdl2Java) { (5)
    inputs.files(extractWsdl)
    toolOptions {
        wsdl.fileProvider(extractWsdl.map { it.outputs.files.singleFile })
    }
}

import io.mateo.cxf.codegen.wsdl2java.Wsdl2Java

val myConfiguration: Configuration by configurations.creating (1)

dependencies {
    myConfiguration("org.apache.cxf:cxf-testutils:3.5.3") (2)
}

val copyArtifact = tasks.register("copyArtifact", Copy::class) { (3)
    from(myConfiguration) {
        include {
            it.name.startsWith("cxf-testutils")
        }
    }
    into(layout.buildDirectory.dir("copied-artifact"))
}

val extractWsdl = tasks.register("extractWsdl") { (4)
    val wsdlFile = layout.buildDirectory.file("extracted.wsdl")
    inputs.files(copyArtifact)
    outputs.file(wsdlFile)
    doLast {
        // Assumes single JAR artifact from previous task
        val archive = inputs.files.singleFile.walk().filter { it.isFile }.single()
        val textResource = resources.text.fromArchiveEntry(archive, "wsdl/calculator.wsdl")
        val f = wsdlFile.get().asFile
        f.createNewFile()
        f.writeText(textResource.asString())
    }
}

tasks.register("calculator", Wsdl2Java::class) { (5)
    inputs.files(extractWsdl)
    toolOptions {
        wsdl.fileProvider(extractWsdl.map { it.outputs.files.singleFile })
    }
}

import io.mateo.cxf.codegen.wsdl2java.Wsdl2Java

// ...

dependencies {
    implementation "org.apache.cxf.xjc-utils:cxf-xjc-runtime:3.3.2" (1)
    cxfCodegen "org.apache.cxf.xjcplugins:cxf-xjc-ts:3.3.2" (2)
}

tasks.register("calculator", Wsdl2Java) {
    toolOptions {
        wsdl.set(layout.projectDirectory.file("calculator.wsdl"))
        xjcArgs.add("-Xts") (3)
    }
}

import io.mateo.cxf.codegen.wsdl2java.Wsdl2Java

// ...

dependencies {
    implementation("org.apache.cxf.xjc-utils:cxf-xjc-runtime:3.3.2") (1)
    cxfCodegen("org.apache.cxf.xjcplugins:cxf-xjc-ts:3.3.2") (2)
}

tasks.register("calculator", Wsdl2Java::class) {
    toolOptions {
        wsdl.set(layout.projectDirectory.file("calculator.wsdl"))
        xjcArgs.add("-Xts") (3)
    }
}