Class WsdlOption
- java.lang.Object
-
- io.mateo.cxf.codegen.wsdl2java.WsdlOption
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.gradle.api.Named
Named.Namer
-
-
Constructor Summary
Constructors Constructor Description WsdlOption(String name, ObjectFactory objects, ProjectLayout layout)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>generateArgs()Generate arguments forwsdl2java.Property<Boolean>getAllowElementRefs()Enables or disables disregarding the rule given in section 2.3.1.2(v) of the JAX-WS 2.2 specification disallowing element references when using wrapper-style mapping.ListProperty<String>getAsyncMethods()Specifies subsequently generated Java class methods to allow for client-side asynchronous calls, similar toenableAsyncMappingin a JAX-WS binding file.Property<Boolean>getAutoNameResolution()Enables or disables automatically resolving naming conflicts without requiring the use of binding customizations.ListProperty<String>getBareMethods()Specifies subsequently generated Java class methods to have wrapper style, similar toenableWrapperStylein JAX-WS binding file.SetProperty<String>getBindingFiles()Specifies JAX-WS or JAXB binding files or XMLBeans context files.Property<String>getCatalog()Specify catalog file to map the imported WSDL/schema.Property<String>getDatabinding()Specifies the databinding.Property<Boolean>getDefaultExcludesNamespace()Enables or disables the loading of the default excludes namespace mapping.Property<Boolean>getDefaultNamespacePackageMapping()Enables or disables the loading of the default namespace package name mapping.Property<String>getEncoding()Encoding to use for generated sources (since CXF version 2.5.4).Property<String>getExceptionSuper()Specifies the superclass for fault beans generated fromwsdl:faultelementsProperty<Boolean>getExtendedSoapHeaders()Enables or disables processing of implicit SOAP headers (i.e.ListProperty<String>getExtraArgs()Specifies extra arguments to pass to the command-line code generator.Property<String>getFaultSerialVersionUid()Specifies how to generate serial version UID of fault exceptions.Property<String>getFrontend()Specifies the frontend.Property<Boolean>getMarkGenerated()Enables or disables adding the@Generatedannotation to classes generated.ListProperty<String>getMimeMethods()Specifies subsequently generated Java class methods to enable mime:content mapping, similar toenableMIMEContentin JAX-WS binding file.StringgetName()ListProperty<String>getNamespaceExcludes()Ignore the specified WSDL schema namespace when generating code.Property<Boolean>getNoAddressBinding()For compatibility with CXF 2.0, this flag directs the code generator to generate the older CXF proprietary WS-Addressing types instead of the JAX-WS 2.1 compliant WS-Addressing types.Property<Boolean>getNoTypes()Enables or disables generation of the type classes.DirectoryPropertygetOutputDir()Specifies the directory the generated code files are written.ListProperty<String>getPackageNames()Specifies zero, or more, package names to use for the generated code.ListProperty<String>getSeiSuper()Specifies the superinterfaces to use for generated SEIs.Property<String>getServiceName()Specifies the WSDL service name to use for the generated code.Property<Boolean>getSuppressGeneratedDate()Enables or disables writing the current timestamp in the generated file (since CXF version 3.2.2).Property<String>getValidateWsdl()Enables validating the WSDL before generating the code.Property<Boolean>getVerbose()Enables or disables verbosity.RegularFilePropertygetWsdl()WSDL file to process.Property<Boolean>getWsdlList()Specifies that thewsdlurlcontains a plain text, new line delimited, list ofwsdlurls instead of the WSDL itself.Property<String>getWsdlLocation()Specifies the value of the@WebServiceClientannotation'swsdlLocationproperty.Property<String>getWsdlVersion()Specifies the WSDL version.ListProperty<String>getXjcArgs()Specifies arguments that are passed directly to the XJC processor when using the JAXB data binding.
-
-
-
Constructor Detail
-
WsdlOption
@Inject public WsdlOption(String name, ObjectFactory objects, ProjectLayout layout)
-
-
Method Detail
-
getWsdl
public RegularFileProperty getWsdl()
WSDL file to process.
-
getPackageNames
public ListProperty<String> getPackageNames()
Specifies zero, or more, package names to use for the generated code.Optionally specifies the WSDL namespace to package name mapping.
- Specified by:
getPackageNamesin interfaceOption- Returns:
- package names
-
getExtraArgs
public ListProperty<String> getExtraArgs()
Specifies extra arguments to pass to the command-line code generator.- Specified by:
getExtraArgsin interfaceOption- Returns:
- extra arguments
-
getXjcArgs
public ListProperty<String> getXjcArgs()
Specifies arguments that are passed directly to the XJC processor when using the JAXB data binding.- Specified by:
getXjcArgsin interfaceOption- Returns:
- xjc arguments
-
getAsyncMethods
public ListProperty<String> getAsyncMethods()
Specifies subsequently generated Java class methods to allow for client-side asynchronous calls, similar toenableAsyncMappingin a JAX-WS binding file.- Specified by:
getAsyncMethodsin interfaceOption- Returns:
- async methods
-
getBareMethods
public ListProperty<String> getBareMethods()
Specifies subsequently generated Java class methods to have wrapper style, similar toenableWrapperStylein JAX-WS binding file.- Specified by:
getBareMethodsin interfaceOption- Returns:
- bare methods
-
getMimeMethods
public ListProperty<String> getMimeMethods()
Specifies subsequently generated Java class methods to enable mime:content mapping, similar toenableMIMEContentin JAX-WS binding file.- Specified by:
getMimeMethodsin interfaceOption- Returns:
- mime methods
-
getNamespaceExcludes
public ListProperty<String> getNamespaceExcludes()
Ignore the specified WSDL schema namespace when generating code.Optionally specifies the Java package name used by types described in the excluded namespace(s) using schema-namespace[=java-packagename]
- Specified by:
getNamespaceExcludesin interfaceOption- Returns:
- namespace excludes
-
getDefaultExcludesNamespace
public Property<Boolean> getDefaultExcludesNamespace()
Enables or disables the loading of the default excludes namespace mapping.If not set,
wsdl2javadefaults totrue.- Specified by:
getDefaultExcludesNamespacein interfaceOption- Returns:
- default excludes namespace indicator
-
getDefaultNamespacePackageMapping
public Property<Boolean> getDefaultNamespacePackageMapping()
Enables or disables the loading of the default namespace package name mapping.If not set,
wsdl2javadefaults totrueand http://www.w3.org/2005/08/addressing package mapping will be enabled.- Specified by:
getDefaultNamespacePackageMappingin interfaceOption- Returns:
- default namespace package mapping indicator
-
getBindingFiles
public SetProperty<String> getBindingFiles()
Specifies JAX-WS or JAXB binding files or XMLBeans context files.The values are evaluated as per
Directory.file(String)fromProjectLayout.getProjectDirectory()- Specified by:
getBindingFilesin interfaceOption- Returns:
- binding files
-
getWsdlLocation
public Property<String> getWsdlLocation()
Specifies the value of the@WebServiceClientannotation'swsdlLocationproperty.- Specified by:
getWsdlLocationin interfaceOption- Returns:
- wsdl location
-
getWsdlList
public Property<Boolean> getWsdlList()
Specifies that thewsdlurlcontains a plain text, new line delimited, list ofwsdlurls instead of the WSDL itself.- Specified by:
getWsdlListin interfaceOption- Returns:
- wsdl list flag
-
getFrontend
public Property<String> getFrontend()
Specifies the frontend. Currently only supports JAX-WS CXF frontends and ajaxws21frontend to generate JAX-WS 2.1 compliant code.If not set,
wsdl2javadefaults tojaxws- Specified by:
getFrontendin interfaceOption- Returns:
- frontend
-
getDatabinding
public Property<String> getDatabinding()
Specifies the databinding. Currently supports JAXB, XMLBeans, SDO (sdo-static * and sdo-dynamic), and JiBX.If not set,
wsdl2javadefaults tojaxb- Specified by:
getDatabindingin interfaceOption- Returns:
- databinding
-
getWsdlVersion
public Property<String> getWsdlVersion()
Specifies the WSDL version.If not set,
wsdl2javadefaults toWSDL1.1; currently supports only WSDL1.1 version.- Specified by:
getWsdlVersionin interfaceOption- Returns:
- wsdl version
-
getCatalog
public Property<String> getCatalog()
Specify catalog file to map the imported WSDL/schema.- Specified by:
getCatalogin interfaceOption- Returns:
- catalog
-
getExtendedSoapHeaders
public Property<Boolean> getExtendedSoapHeaders()
Enables or disables processing of implicit SOAP headers (i.e. SOAP headers defined in thewsdl:binding, but notwsdl:portTypesection.)Processing the SOAP headers requires the SOAP binding JARs available on the classpath which was not the default in CXF 2.4.x and older. You may need to add a dependency to
cxf-rt-binding-soapfor this flag to work.If not set,
wsdl2javadefaults tofalse.- Specified by:
getExtendedSoapHeadersin interfaceOption- Returns:
- extended SOAP headers indicator
-
getValidateWsdl
public Property<String> getValidateWsdl()
Enables validating the WSDL before generating the code.- Specified by:
getValidateWsdlin interfaceOption- Returns:
- validate WSDL
-
getNoTypes
public Property<Boolean> getNoTypes()
Enables or disables generation of the type classes.If not set,
wsdl2javadefaults tofalse.- Specified by:
getNoTypesin interfaceOption- Returns:
- no types indicator
-
getFaultSerialVersionUid
public Property<String> getFaultSerialVersionUid()
Specifies how to generate serial version UID of fault exceptions.Use one of the following:
NONETIMESTAMPFQCN- a specific number
If not set,
wsdl2javadefaults toNONE.- Specified by:
getFaultSerialVersionUidin interfaceOption- Returns:
- fault serial version UID
-
getExceptionSuper
public Property<String> getExceptionSuper()
Specifies the superclass for fault beans generated fromwsdl:faultelementsIf not set,
wsdl2javadefaults toException.- Specified by:
getExceptionSuperin interfaceOption- Returns:
- exception superclass
-
getSeiSuper
public ListProperty<String> getSeiSuper()
Specifies the superinterfaces to use for generated SEIs.- Specified by:
getSeiSuperin interfaceOption- Returns:
- super interfaces
-
getMarkGenerated
public Property<Boolean> getMarkGenerated()
Enables or disables adding the@Generatedannotation to classes generated.- Specified by:
getMarkGeneratedin interfaceOption- Returns:
- mark generated indicator
-
getSuppressGeneratedDate
public Property<Boolean> getSuppressGeneratedDate()
Enables or disables writing the current timestamp in the generated file (since CXF version 3.2.2).- Specified by:
getSuppressGeneratedDatein interfaceOption- Returns:
- suppress generated date indicator
-
getServiceName
public Property<String> getServiceName()
Specifies the WSDL service name to use for the generated code.- Specified by:
getServiceNamein interfaceOption- Returns:
- service name
-
getAutoNameResolution
public Property<Boolean> getAutoNameResolution()
Enables or disables automatically resolving naming conflicts without requiring the use of binding customizations.- Specified by:
getAutoNameResolutionin interfaceOption- Returns:
- auto name resolution indicator
-
getNoAddressBinding
public Property<Boolean> getNoAddressBinding()
For compatibility with CXF 2.0, this flag directs the code generator to generate the older CXF proprietary WS-Addressing types instead of the JAX-WS 2.1 compliant WS-Addressing types.- Specified by:
getNoAddressBindingin interfaceOption- Returns:
- no address binding indicator
-
getAllowElementRefs
public Property<Boolean> getAllowElementRefs()
Enables or disables disregarding the rule given in section 2.3.1.2(v) of the JAX-WS 2.2 specification disallowing element references when using wrapper-style mapping.- Specified by:
getAllowElementRefsin interfaceOption- Returns:
- allow element references indicator
-
getEncoding
public Property<String> getEncoding()
Encoding to use for generated sources (since CXF version 2.5.4).- Specified by:
getEncodingin interfaceOption- Returns:
- encoding
-
getVerbose
public Property<Boolean> getVerbose()
Enables or disables verbosity.- Specified by:
getVerbosein interfaceOption- Returns:
- verbosity indicator
-
getOutputDir
public DirectoryProperty getOutputDir()
Specifies the directory the generated code files are written.If not set, the convention is
"${project.buildDir}/generated-sources"- Specified by:
getOutputDirin interfaceGenericWsdlOption- Returns:
- output directory
-
-