com.intershop.gradle.wsdl.tasks

Class AbstractWSDL2Java

com.intershop.gradle.wsdl.tasks.AbstractWSDL2Java

Direct Known Subclasses:

WSDL2Java, WSDL2Java

public class AbstractWSDL2Java

Abbstract class for axis 1 and axis2 code generator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractWSDL2Java.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static AbstractWSDL2Java.Companion	Companion

Constructor Summary

Constructors

Constructor and Description
AbstractWSDL2Java() Abbstract class for axis 1 and axis2 code generator.

Method Summary

Modifier and Type	Method and Description
void	args(java.lang.String arg) Add additional arguments for args.
void	forkOptions(org.gradle.api.Action<? super org.gradle.process.JavaForkOptions> forkOptionsAction) Adds additional fork options.
java.util.List<java.lang.String>	getArgs() Additional parameters for WSDL Command Line Client.
boolean	getGenerateTestcase() Generate a client-side JUnit test case. This test case can stand on its own, but it doesn't really do anything except pass default values (null for objects, 0 or false for primitive types). Like the generated implementation file, the generated test case file could be considered a template that you may fill in.
org.gradle.api.Action<? super org.gradle.process.JavaForkOptions>	getInternalForkOptionsAction() Java fork options for the Java task.
java.io.File	getNamespacePackageMappingFile() If there are a number of namespaces in the WSDLExtension document, listing a mapping for them all could become tedious. To help keep the command line terse, WSDL2Java will also look for mappings in a properties file. By default, this file is named "NStoPkg.properties" and it must reside in the default package (ie., no package). But you can explicitly provide your own file using this option.
java.util.List<java.lang.String>	getNamespacePackageMappingList() By default, package names are generated from the namespace strings in the WSDLExtension document in a magical manner (typically, if the namespace is of the form "http://x.y.com" or "urn:x.y.com" the corresponding package will be "com.y.x"). If this magic is not what you want, you can provide your own mapping using the this maps argument. For example, if there is a namespace in the WSDLExtension document called "urn:AddressFetcher2", and you want files generated from the objects within this namespace to reside in the package samples.addr, you would provide the following option:
org.gradle.api.NamedDomainObjectContainer<com.intershop.gradle.wsdl.extension.data.NamespacePackageMapping>	getNamespacePackageMappings() List of namespace mappings.
java.io.File	getOutputDir() Output directory for generated sources.
java.lang.String	getPackageName() This is a shorthand option to map all namespaces in a WSDLExtension document to the same Java package name. This can be useful, but dangerous. You must make sure that you understand the effects of doing this. For instance there may be multiple types with the same name in different namespaces. Only for Axis1: It is an error to use the --NStoPkg switch and --package at the same time.
java.io.File	getWsdlFile() Input wsdl file.
void	provideArguments(org.gradle.api.provider.Provider<java.util.List> arguments) Add provider for args.
void	provideGenerateTestcase(org.gradle.api.provider.Provider<java.lang.Boolean> generateTestcase) Add provider for generateTestcase.
void	provideNamespacePackageMappingFile(org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> namespacePackageMappingFile) Add provider for namespacePackageMappingFile.
void	provideOutputDir(org.gradle.api.provider.Provider<org.gradle.api.file.Directory> outputDir) Add provider for outputDir.
void	providePackageName(org.gradle.api.provider.Provider<java.lang.String> packageName) Add provider for packageName.
void	provideWsdlFile(org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> wsdlFile) Add provider for wsdlFile.
void	setArgs(java.util.List<java.lang.String> value) Additional parameters for WSDL Command Line Client.
void	setGenerateTestcase(boolean value) Generate a client-side JUnit test case. This test case can stand on its own, but it doesn't really do anything except pass default values (null for objects, 0 or false for primitive types). Like the generated implementation file, the generated test case file could be considered a template that you may fill in.
void	setInternalForkOptionsAction(org.gradle.api.Action<? super org.gradle.process.JavaForkOptions> p) Java fork options for the Java task.
void	setNamespacePackageMappingFile(java.io.File value) If there are a number of namespaces in the WSDLExtension document, listing a mapping for them all could become tedious. To help keep the command line terse, WSDL2Java will also look for mappings in a properties file. By default, this file is named "NStoPkg.properties" and it must reside in the default package (ie., no package). But you can explicitly provide your own file using this option.
void	setNamespacePackageMappings(org.gradle.api.NamedDomainObjectContainer<com.intershop.gradle.wsdl.extension.data.NamespacePackageMapping> p) List of namespace mappings.
void	setOutputDir(java.io.File value) Output directory for generated sources.
void	setPackageName(java.lang.String value) This is a shorthand option to map all namespaces in a WSDLExtension document to the same Java package name. This can be useful, but dangerous. You must make sure that you understand the effects of doing this. For instance there may be multiple types with the same name in different namespaces. Only for Axis1: It is an error to use the --NStoPkg switch and --package at the same time.
void	setWsdlFile(java.io.File value) Input wsdl file.

Field Detail

Companion

public static AbstractWSDL2Java.Companion Companion

Constructor Detail

AbstractWSDL2Java

public AbstractWSDL2Java()

Abbstract class for axis 1 and axis2 code generator.

Method Detail

getPackageName

public java.lang.String getPackageName()

This is a shorthand option to map all namespaces in a WSDLExtension document to the same Java package name. This can be useful, but dangerous. You must make sure that you understand the effects of doing this. For instance there may be multiple types with the same name in different namespaces. Only for Axis1: It is an error to use the --NStoPkg switch and --package at the same time.

setPackageName

public void setPackageName(java.lang.String value)

This is a shorthand option to map all namespaces in a WSDLExtension document to the same Java package name. This can be useful, but dangerous. You must make sure that you understand the effects of doing this. For instance there may be multiple types with the same name in different namespaces. Only for Axis1: It is an error to use the --NStoPkg switch and --package at the same time.

providePackageName

public void providePackageName(org.gradle.api.provider.Provider<java.lang.String> packageName)

Add provider for packageName.

getNamespacePackageMappings

public org.gradle.api.NamedDomainObjectContainer<com.intershop.gradle.wsdl.extension.data.NamespacePackageMapping> getNamespacePackageMappings()

List of namespace mappings.

setNamespacePackageMappings

public void setNamespacePackageMappings(org.gradle.api.NamedDomainObjectContainer<com.intershop.gradle.wsdl.extension.data.NamespacePackageMapping> p)

List of namespace mappings.

getNamespacePackageMappingList

public java.util.List<java.lang.String> getNamespacePackageMappingList()

By default, package names are generated from the namespace strings in the WSDLExtension document in a magical manner (typically, if the namespace is of the form "http://x.y.com" or "urn:x.y.com" the corresponding package will be "com.y.x"). If this magic is not what you want, you can provide your own mapping using the this maps argument. For example, if there is a namespace in the WSDLExtension document called "urn:AddressFetcher2", and you want files generated from the objects within this namespace to reside in the package samples.addr, you would provide the following option:

getGenerateTestcase

public boolean getGenerateTestcase()

Generate a client-side JUnit test case. This test case can stand on its own, but it doesn't really do anything except pass default values (null for objects, 0 or false for primitive types). Like the generated implementation file, the generated test case file could be considered a template that you may fill in.

setGenerateTestcase

public void setGenerateTestcase(boolean value)

Generate a client-side JUnit test case. This test case can stand on its own, but it doesn't really do anything except pass default values (null for objects, 0 or false for primitive types). Like the generated implementation file, the generated test case file could be considered a template that you may fill in.

provideGenerateTestcase

public void provideGenerateTestcase(org.gradle.api.provider.Provider<java.lang.Boolean> generateTestcase)

Add provider for generateTestcase.

getNamespacePackageMappingFile

public java.io.File getNamespacePackageMappingFile()

If there are a number of namespaces in the WSDLExtension document, listing a mapping for them all could become tedious. To help keep the command line terse, WSDL2Java will also look for mappings in a properties file. By default, this file is named "NStoPkg.properties" and it must reside in the default package (ie., no package). But you can explicitly provide your own file using this option.

The entries in this file are of the same form as the arguments to the namespacePackageMapping option. For example, instead of providing the command line option as above, we could provide the same information in a properties file:

(Note that the colon must be escaped in the properties file.)

If an entry for a given mapping exists both with namespacePackageMapping and in this properties file, the namespacePackageMapping entry takes precedence.

setNamespacePackageMappingFile

public void setNamespacePackageMappingFile(java.io.File value)

If there are a number of namespaces in the WSDLExtension document, listing a mapping for them all could become tedious. To help keep the command line terse, WSDL2Java will also look for mappings in a properties file. By default, this file is named "NStoPkg.properties" and it must reside in the default package (ie., no package). But you can explicitly provide your own file using this option.

The entries in this file are of the same form as the arguments to the namespacePackageMapping option. For example, instead of providing the command line option as above, we could provide the same information in a properties file:

(Note that the colon must be escaped in the properties file.)

If an entry for a given mapping exists both with namespacePackageMapping and in this properties file, the namespacePackageMapping entry takes precedence.

provideNamespacePackageMappingFile

public void provideNamespacePackageMappingFile(org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> namespacePackageMappingFile)

Add provider for namespacePackageMappingFile.

getArgs

public java.util.List<java.lang.String> getArgs()

Additional parameters for WSDL Command Line Client.

setArgs

public void setArgs(java.util.List<java.lang.String> value)

Additional parameters for WSDL Command Line Client.

args

public void args(java.lang.String arg)

Add additional arguments for args.

provideArguments

public void provideArguments(org.gradle.api.provider.Provider<java.util.List> arguments)

Add provider for args.

getOutputDir

public java.io.File getOutputDir()

Output directory for generated sources.

setOutputDir

public void setOutputDir(java.io.File value)

Output directory for generated sources.

provideOutputDir

public void provideOutputDir(org.gradle.api.provider.Provider<org.gradle.api.file.Directory> outputDir)

Add provider for outputDir.

getWsdlFile

public java.io.File getWsdlFile()

Input wsdl file.

setWsdlFile

public void setWsdlFile(java.io.File value)

Input wsdl file.

provideWsdlFile

public void provideWsdlFile(org.gradle.api.provider.Provider<org.gradle.api.file.RegularFile> wsdlFile)

Add provider for wsdlFile.

getInternalForkOptionsAction

public org.gradle.api.Action<? super org.gradle.process.JavaForkOptions> getInternalForkOptionsAction()

Java fork options for the Java task.

setInternalForkOptionsAction

public void setInternalForkOptionsAction(org.gradle.api.Action<? super org.gradle.process.JavaForkOptions> p)

Java fork options for the Java task.

forkOptions

public void forkOptions(org.gradle.api.Action<? super org.gradle.process.JavaForkOptions> forkOptionsAction)

Adds additional fork options.